Struct llvm_rs::value::Function

pub struct Function(_);

A function is a kind of value that can be called and contains blocks of code.

To get the value of each argument to a function, you can use the index operator. For example, &func[0] is the value that represents the first argument to the function.

Implementations

impl Function

pub fn append<'a>(&'a self, name: &str) -> &'a BasicBlock

Add a basic block with the name given to the function and return it.

pub fn blocks(&self) -> BlockIter<'_>

Iterate through this function’s basic blocks.

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

Returns the entry block of this function or None if there is none.

pub fn get_signature(&self) -> &FunctionType

Returns the function signature representing this function’s signature.

Methods from Deref<Target = GlobalValue>

pub fn set_linkage(&self, linkage: Linkage)

Set the linkage type for this global

pub fn get_linkage(&self) -> Linkage

Returns the linkage type for this global

pub fn is_declaration(&self) -> bool

Returns true if this global is a declaration (as opposed to a definition).

Methods from Deref<Target = Value>

pub fn get_name(&self) -> Option<&str>

Returns the name of this value, or None if it lacks a name

pub fn set_name(&self, name: &str)

Sets the name of this value

pub fn get_type(&self) -> &Type

Returns the type of this value

Trait Implementations

impl Debug for Function

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

Formats the value using the given formatter.

impl Deref for Function

type Target = GlobalValue

The resulting type after dereferencing.

fn deref(&self) -> &GlobalValue

Dereferences the value.

impl<'a> From<&'a Function> for LLVMValueRef

fn from(ty: &'a Function) -> LLVMValueRef

Converts to this type from the input type.

impl<'a> From<&'a mut Function> for LLVMValueRef

fn from(ty: &'a mut Function) -> LLVMValueRef

Converts to this type from the input type.

impl<'a> From<*mut LLVMValue> for &'a Function

fn from(ty: LLVMValueRef) -> &'a Function

Converts to this type from the input type.

impl<'a> From<*mut LLVMValue> for &'a mut Function

fn from(ty: LLVMValueRef) -> &'a mut Function

Converts to this type from the input type.

impl GetContext for Function

fn get_context(&self) -> &Context

Returns a reference to the context that owns this value.

impl Index<usize> for Function

type Output = Arg

The returned type after indexing.

fn index(&self, index: usize) -> &Arg

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a Function

type IntoIter = BlockIter<'a>

Which kind of iterator are we turning this into?

type Item = &'a BasicBlock

The type of the elements being iterated over.

fn into_iter(self) -> BlockIter<'a>

Creates an iterator from a value.

impl<'a> PartialEq<Function> for &'a Function

fn eq(&self, other: &Function) -> 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 PartialEq<Function> for Function

fn eq(&self, other: &Function) -> 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 Sub<GlobalValue> for Function

fn is(value: &GlobalValue) -> bool

Check if the given super value is an instance of this type.

fn from_super(value: &GlobalValue) -> Option<&Function>

Attempt to cast the given super value into an instance of this type.

fn to_super(&self) -> &T

Cast this value to a super value.

impl Sub<Value> for Function

fn is(value: &Value) -> bool

Check if the given super value is an instance of this type.

fn from_super(c: &T) -> Option<&Self>

Attempt to cast the given super value into an instance of this type.

fn to_super(&self) -> &T

Cast this value to a super value.

impl Eq for Function