Struct inkwell::values::FunctionValue

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

Implementations

impl<'ctx> FunctionValue<'ctx>

pub fn get_linkage(self) -> Linkage

pub fn set_linkage(self, linkage: Linkage)

pub fn is_null(self) -> bool

pub fn is_undef(self) -> bool

pub fn print_to_stderr(self)

pub fn verify(self, print: bool) -> bool

pub fn get_next_function(self) -> Option<Self>

pub fn get_previous_function(self) -> Option<Self>

pub fn get_first_param(self) -> Option<BasicValueEnum<'ctx>>

pub fn get_last_param(self) -> Option<BasicValueEnum<'ctx>>

pub fn get_first_basic_block(self) -> Option<BasicBlock<'ctx>>

pub fn get_nth_param(self, nth: u32) -> Option<BasicValueEnum<'ctx>>

pub fn count_params(self) -> u32

pub fn count_basic_blocks(self) -> u32

pub fn get_basic_blocks(self) -> Vec<BasicBlock<'ctx>>

pub fn get_param_iter(self) -> ParamValueIter<'ctx>

pub fn get_params(self) -> Vec<BasicValueEnum<'ctx>>

pub fn get_last_basic_block(self) -> Option<BasicBlock<'ctx>>

pub fn get_name(&self) -> &CStr

Gets the name of a FunctionValue.

pub fn view_function_cfg(self)

View the control flow graph and produce a .dot file

pub fn view_function_cfg_only(self)

Only view the control flow graph

pub unsafe fn delete(self)

pub fn get_type(self) -> FunctionType<'ctx>

Available on crate features llvm8-0 or llvm9-0 or llvm10-0 or llvm11-0 or llvm12-0 or llvm13-0 or llvm14-0 or llvm15-0 or llvm16-0 only.

pub fn has_personality_function(self) -> bool

pub fn get_personality_function(self) -> Option<FunctionValue<'ctx>>

pub fn set_personality_function(self, personality_fn: FunctionValue<'ctx>)

pub fn get_intrinsic_id(self) -> u32

pub fn get_call_conventions(self) -> u32

pub fn set_call_conventions(self, call_conventions: u32)

pub fn get_gc(&self) -> &CStr

pub fn set_gc(self, gc: &str)

pub fn replace_all_uses_with(self, other: FunctionValue<'ctx>)

pub fn add_attribute(self, loc: AttributeLoc, attribute: Attribute)

Adds an Attribute to a particular location in this FunctionValue.

Example

use inkwell::attributes::AttributeLoc;
use inkwell::context::Context;

let context = Context::create();
let module = context.create_module("my_mod");
let void_type = context.void_type();
let fn_type = void_type.fn_type(&[], false);
let fn_value = module.add_function("my_fn", fn_type, None);
let string_attribute = context.create_string_attribute("my_key", "my_val");
let enum_attribute = context.create_enum_attribute(1, 1);

fn_value.add_attribute(AttributeLoc::Return, string_attribute);
fn_value.add_attribute(AttributeLoc::Return, enum_attribute);

pub fn count_attributes(self, loc: AttributeLoc) -> u32

Counts the number of Attributes belonging to the specified location in this FunctionValue.

Example

use inkwell::attributes::AttributeLoc;
use inkwell::context::Context;

let context = Context::create();
let module = context.create_module("my_mod");
let void_type = context.void_type();
let fn_type = void_type.fn_type(&[], false);
let fn_value = module.add_function("my_fn", fn_type, None);
let string_attribute = context.create_string_attribute("my_key", "my_val");
let enum_attribute = context.create_enum_attribute(1, 1);

fn_value.add_attribute(AttributeLoc::Return, string_attribute);
fn_value.add_attribute(AttributeLoc::Return, enum_attribute);

assert_eq!(fn_value.count_attributes(AttributeLoc::Return), 2);

pub fn attributes(self, loc: AttributeLoc) -> Vec<Attribute>

Get all Attributes belonging to the specified location in this FunctionValue.

Example

use inkwell::attributes::AttributeLoc;
use inkwell::context::Context;

let context = Context::create();
let module = context.create_module("my_mod");
let void_type = context.void_type();
let fn_type = void_type.fn_type(&[], false);
let fn_value = module.add_function("my_fn", fn_type, None);
let string_attribute = context.create_string_attribute("my_key", "my_val");
let enum_attribute = context.create_enum_attribute(1, 1);

fn_value.add_attribute(AttributeLoc::Return, string_attribute);
fn_value.add_attribute(AttributeLoc::Return, enum_attribute);

assert_eq!(fn_value.attributes(AttributeLoc::Return), vec![string_attribute, enum_attribute]);

pub fn remove_string_attribute(self, loc: AttributeLoc, key: &str)

Removes a string Attribute belonging to the specified location in this FunctionValue.

Example

use inkwell::attributes::AttributeLoc;
use inkwell::context::Context;

let context = Context::create();
let module = context.create_module("my_mod");
let void_type = context.void_type();
let fn_type = void_type.fn_type(&[], false);
let fn_value = module.add_function("my_fn", fn_type, None);
let string_attribute = context.create_string_attribute("my_key", "my_val");

fn_value.add_attribute(AttributeLoc::Return, string_attribute);
fn_value.remove_string_attribute(AttributeLoc::Return, "my_key");

pub fn remove_enum_attribute(self, loc: AttributeLoc, kind_id: u32)

Removes an enum Attribute belonging to the specified location in this FunctionValue.

Example

use inkwell::attributes::AttributeLoc;
use inkwell::context::Context;

let context = Context::create();
let module = context.create_module("my_mod");
let void_type = context.void_type();
let fn_type = void_type.fn_type(&[], false);
let fn_value = module.add_function("my_fn", fn_type, None);
let enum_attribute = context.create_enum_attribute(1, 1);

fn_value.add_attribute(AttributeLoc::Return, enum_attribute);
fn_value.remove_enum_attribute(AttributeLoc::Return, 1);

pub fn get_enum_attribute( self, loc: AttributeLoc, kind_id: u32 ) -> Option<Attribute>

Gets an enum Attribute belonging to the specified location in this FunctionValue.

Example

use inkwell::attributes::AttributeLoc;
use inkwell::context::Context;

let context = Context::create();
let module = context.create_module("my_mod");
let void_type = context.void_type();
let fn_type = void_type.fn_type(&[], false);
let fn_value = module.add_function("my_fn", fn_type, None);
let enum_attribute = context.create_enum_attribute(1, 1);

fn_value.add_attribute(AttributeLoc::Return, enum_attribute);

assert_eq!(fn_value.get_enum_attribute(AttributeLoc::Return, 1), Some(enum_attribute));

pub fn get_string_attribute( self, loc: AttributeLoc, key: &str ) -> Option<Attribute>

Gets a string Attribute belonging to the specified location in this FunctionValue.

Example

use inkwell::attributes::AttributeLoc;
use inkwell::context::Context;

let context = Context::create();
let module = context.create_module("my_mod");
let void_type = context.void_type();
let fn_type = void_type.fn_type(&[], false);
let fn_value = module.add_function("my_fn", fn_type, None);
let string_attribute = context.create_string_attribute("my_key", "my_val");

fn_value.add_attribute(AttributeLoc::Return, string_attribute);

assert_eq!(fn_value.get_string_attribute(AttributeLoc::Return, "my_key"), Some(string_attribute));

pub fn set_param_alignment(self, param_index: u32, alignment: u32)

pub fn as_global_value(self) -> GlobalValue<'ctx>

Gets the GlobalValue version of this FunctionValue. This allows you to further inspect its global properties or even convert it to a PointerValue.

pub fn set_subprogram(self, subprogram: DISubprogram<'ctx>)

Available on crate features llvm7-0 or llvm8-0 or llvm9-0 or llvm10-0 or llvm11-0 or llvm12-0 or llvm13-0 or llvm14-0 or llvm15-0 or llvm16-0 only.

Set the debug info descriptor

pub fn get_subprogram(self) -> Option<DISubprogram<'ctx>>

Available on crate features llvm7-0 or llvm8-0 or llvm9-0 or llvm10-0 or llvm11-0 or llvm12-0 or llvm13-0 or llvm14-0 or llvm15-0 or llvm16-0 only.

Get the debug info descriptor

pub fn get_section(&self) -> Option<&CStr>

Get the section to which this function belongs

pub fn set_section(self, section: Option<&str>)

Set the section to which this function should belong

Trait Implementations

impl<'ctx> AnyValue<'ctx> for FunctionValue<'ctx>

fn as_any_value_enum(&self) -> AnyValueEnum<'ctx>

Returns an enum containing a typed version of AnyValue.

fn print_to_string(&self) -> LLVMString

Prints a value to a LLVMString

fn is_poison(&self) -> bool

Available on crate features llvm12-0 or llvm13-0 or llvm14-0 or llvm15-0 or llvm16-0 only.

Returns whether the value is poison

impl AsValueRef for FunctionValue<'_>

fn as_value_ref(&self) -> LLVMValueRef

impl<'ctx> Clone for FunctionValue<'ctx>

fn clone(&self) -> FunctionValue<'ctx>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FunctionValue<'_>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for FunctionValue<'_>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'ctx> From<FunctionValue<'ctx>> for AnyValueEnum<'ctx>

fn from(value: FunctionValue<'_>) -> AnyValueEnum<'_>

Converts to this type from the input type.

impl<'ctx> Hash for FunctionValue<'ctx>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'ctx> PartialEq<AnyValueEnum<'ctx>> for FunctionValue<'ctx>

fn eq(&self, other: &AnyValueEnum<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'ctx> PartialEq<FunctionValue<'ctx>> for AnyValueEnum<'ctx>

fn eq(&self, other: &FunctionValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'ctx> PartialEq for FunctionValue<'ctx>

fn eq(&self, other: &FunctionValue<'ctx>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'ctx> PassManagerSubType for FunctionValue<'ctx>

type Input = Module<'ctx>

unsafe fn create<I: Borrow<Self::Input>>(input: I) -> LLVMPassManagerRef

unsafe fn run_in_pass_manager(&self, pass_manager: &PassManager<Self>) -> bool

impl<'ctx> TryFrom<AnyValueEnum<'ctx>> for FunctionValue<'ctx>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: AnyValueEnum<'ctx>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'ctx> Copy for FunctionValue<'ctx>

impl<'ctx> Eq for FunctionValue<'ctx>

impl<'ctx> StructuralEq for FunctionValue<'ctx>

impl<'ctx> StructuralPartialEq for FunctionValue<'ctx>