Struct FunctionType

Source

pub struct FunctionType<'ctx> { /* private fields */ }

Expand description

A FunctionType is the type of a function variable.

Implementations§

Source §

impl<'ctx> FunctionType<'ctx>

Source

pub unsafe fn new(fn_type: LLVMTypeRef) -> Self

Create FunctionType from LLVMTypeRef

§Safety

Undefined behavior, if referenced type isn’t function type

Source

pub fn ptr_type(self, address_space: AddressSpace) -> PointerType<'ctx>

👎Deprecated:

Starting from version 15.0, LLVM doesn’t differentiate between pointer types. Use Context::ptr_type instead.

Creates a PointerType with this FunctionType for its element type.

§Example

use inkwell::context::Context;
use inkwell::AddressSpace;

let context = Context::create();
let f32_type = context.f32_type();
let fn_type = f32_type.fn_type(&[], false);
let fn_ptr_type = fn_type.ptr_type(AddressSpace::default());

#[cfg(feature = "typed-pointers")]
assert_eq!(fn_ptr_type.get_element_type().into_function_type(), fn_type);

Source

pub fn is_var_arg(self) -> bool

Determines whether or not a FunctionType is a variadic function.

§Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let fn_type = f32_type.fn_type(&[], true);

assert!(fn_type.is_var_arg());

Source

pub fn get_param_types(self) -> Vec<BasicMetadataTypeEnum<'ctx>>

Gets param types this FunctionType has.

§Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let fn_type = f32_type.fn_type(&[f32_type.into()], true);
let param_types = fn_type.get_param_types();

assert_eq!(param_types.len(), 1);
assert_eq!(param_types[0].into_float_type(), f32_type);

Source

pub fn count_param_types(self) -> u32

Counts the number of param types this FunctionType has.

§Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let fn_type = f32_type.fn_type(&[f32_type.into()], true);

assert_eq!(fn_type.count_param_types(), 1);

Source

pub fn is_sized(self) -> bool

Gets whether or not this FunctionType is sized or not. This is likely always false and may be removed in the future.

§Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let fn_type = f32_type.fn_type(&[], true);

assert!(!fn_type.is_sized());

Source

pub fn get_context(self) -> ContextRef<'ctx>

Gets a reference to the Context this FunctionType was created in.

§Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let fn_type = f32_type.fn_type(&[], true);

assert_eq!(fn_type.get_context(), context);

Source

pub fn print_to_string(self) -> LLVMString

Print the definition of a FunctionType to LLVMString.

Source

pub fn get_return_type(self) -> Option<BasicTypeEnum<'ctx>>

Gets the return type of this FunctionType.

§Example

use inkwell::context::Context;

let context = Context::create();
let f32_type = context.f32_type();
let fn_type = f32_type.fn_type(&[], true);

assert_eq!(fn_type.get_return_type().unwrap().into_float_type(), f32_type);