Struct inkwell::values::FunctionValue

pub struct FunctionValue { /* fields omitted */ }

Methods

impl FunctionValue

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_string(&self) -> LLVMString

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>

pub fn get_last_param(&self) -> Option<BasicValueEnum>

pub fn get_first_basic_block(&self) -> Option<BasicBlock>

pub fn append_basic_block(&self, name: &str) -> BasicBlock

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

pub fn count_params(&self) -> u32

pub fn count_basic_blocks(&self) -> u32

pub fn get_basic_blocks(&self) -> Vec<BasicBlock>

pub fn get_param_iter(&self) -> ParamValueIter

pub fn get_params(&self) -> Vec<BasicValueEnum>

pub fn get_last_basic_block(&self) -> Option<BasicBlock>

pub fn get_name(&self) -> &CStr

pub fn view_function_config(&self)

pub fn view_function_config_only(&self)

pub unsafe fn delete(self)

pub fn get_type(&self) -> FunctionType

pub fn has_metadata(&self) -> bool

pub fn get_metadata(&self, kind_id: u32) -> Option<MetadataValue>

pub fn set_metadata(&self, metadata: MetadataValue, kind_id: u32)

pub fn has_personality_function(&self) -> bool

pub fn get_personality_function(&self) -> Option<FunctionValue>

pub fn set_personality_function(&self, personality_fn: FunctionValue)

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)

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 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

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

Trait Implementations

impl PassManagerSubType for FunctionValue

type Input = Module

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

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

impl AnyValue for FunctionValue

fn as_any_value_enum(&self) -> AnyValueEnum

Returns an enum containing a typed version of AnyValue.

impl Eq for FunctionValue

impl Into<Either<FunctionValue, PointerValue>> for FunctionValue

fn into(self) -> Either<FunctionValue, PointerValue>

Performs the conversion.

impl Clone for FunctionValue

fn clone(&self) -> FunctionValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<FunctionValue> for AnyValueEnum

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<AnyValueEnum> for FunctionValue

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<FunctionValue> for FunctionValue

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

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

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

This method tests for !=.

impl From<FunctionValue> for AnyValueEnum

fn from(value: FunctionValue) -> AnyValueEnum

Performs the conversion.

impl Copy for FunctionValue

impl Hash for FunctionValue

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, 

Feeds a slice of this type into the given [Hasher].

impl Debug for FunctionValue

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

Formats the value using the given formatter.