Struct llvm_ir::function::Function

pub struct Function {

    pub name: String,
    pub parameters: Vec<Parameter>,
    pub is_var_arg: bool,
    pub return_type: TypeRef,
    pub basic_blocks: Vec<BasicBlock>,
    pub function_attributes: Vec<FunctionAttribute>,
    pub return_attributes: Vec<ParameterAttribute>,
    pub linkage: Linkage,
    pub visibility: Visibility,
    pub dll_storage_class: DLLStorageClass,
    pub calling_convention: CallingConvention,
    pub section: Option<String>,
    pub comdat: Option<Comdat>,
    pub alignment: u32,
    pub garbage_collector_name: Option<String>,
    pub personality_function: Option<ConstantRef>,
    pub debugloc: Option<DebugLoc>,
}

See LLVM 14 docs on Functions

Fields

name: String

parameters: Vec<Parameter>

is_var_arg: bool

return_type: TypeRef

basic_blocks: Vec<BasicBlock>

function_attributes: Vec<FunctionAttribute>

return_attributes: Vec<ParameterAttribute>

linkage: Linkage

visibility: Visibility

dll_storage_class: DLLStorageClass

calling_convention: CallingConvention

section: Option<String>

comdat: Option<Comdat>

alignment: u32

garbage_collector_name: Option<String>

See LLVM 14 docs on Garbage Collector Strategy Names

personality_function: Option<ConstantRef>

Personalities are used for exception handling. See LLVM 14 docs on Personality Function

debugloc: Option<DebugLoc>

Implementations

impl Function

pub fn get_bb_by_name(&self, name: &Name) -> Option<&BasicBlock>

Get the BasicBlock having the given Name (if any).

pub fn new(name: impl Into<String>) -> Self

A Function instance as empty as possible, using defaults

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl HasDebugLoc for Function

fn get_debug_loc(&self) -> &Option<DebugLoc>

Returns the DebugLoc associated with the given Instruction, Terminator, GlobalVariable, or Function; or None if it doesn’t have a DebugLoc.

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 Typed for Function

fn get_type(&self, types: &Types) -> TypeRef

impl StructuralPartialEq for Function