Struct Module

pub struct Module {
    pub name: String,
    pub source_file_name: String,
    pub data_layout: DataLayout,
    pub target_triple: Option<String>,
    pub functions: Vec<Function>,
    pub func_declarations: Vec<FunctionDeclaration>,
    pub global_vars: Vec<GlobalVariable>,
    pub global_aliases: Vec<GlobalAlias>,
    pub global_ifuncs: Vec<GlobalIFunc>,
    pub inline_assembly: String,
    pub types: Types,
}

See LLVM 14 docs on Module Structure

Fields

name: String

The name of the module

source_file_name: String

See LLVM 14 docs on Source Filename

data_layout: DataLayout

See LLVM 14 docs on Data Layout

target_triple: Option<String>

See LLVM 14 docs on Target Triple

functions: Vec<Function>

Functions which are defined (not just declared) in this Module. See LLVM 14 docs on Functions

func_declarations: Vec<FunctionDeclaration>

Functions which are declared (but not defined) in this Module. See LLVM 14 docs on Functions

global_vars: Vec<GlobalVariable>

See LLVM 14 docs on Global Variables

global_aliases: Vec<GlobalAlias>

See LLVM 14 docs on Global Aliases

global_ifuncs: Vec<GlobalIFunc>

See LLVM 14 docs on Global IFuncs

inline_assembly: String

See LLVM 14 docs on Module-Level Inline Assembly

types: Types

Holds a reference to all of the Types used in the Module, and facilitates lookups so you can get a TypeRef to the Type you want.

Implementations

impl Module

pub fn type_of<T: Typed + ?Sized>(&self, t: &T) -> TypeRef

Get the type of anything that is Typed.

pub fn get_func_by_name(&self, name: &str) -> Option<&Function>

Get the Function having the given name (if any). Note that functions are named with Strings and not Names.

Note also that this will only find fully defined functions, not FunctionDeclarations.

pub fn get_func_decl_by_name(&self, name: &str) -> Option<&FunctionDeclaration>

Get the FunctionDeclaration having the given name (if any). Note that functions are named with Strings and not Names.

Note also that this will only find function declarations, and will not find defined functions (use get_func_by_name() for that).

pub fn get_global_var_by_name(&self, name: &Name) -> Option<&GlobalVariable>

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

pub fn get_global_alias_by_name(&self, name: &Name) -> Option<&GlobalAlias>

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

pub fn get_global_ifunc_by_name(&self, name: &Name) -> Option<&GlobalIFunc>

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

pub fn from_bc_path(path: impl AsRef<Path>) -> Result<Self, String>

Parse the LLVM bitcode (.bc) file at the given path to create a Module

pub fn from_ir_path(path: impl AsRef<Path>) -> Result<Self, String>

Parse the LLVM text IR (.ll) file at the given path to create a Module

pub fn from_ir_str(str: &str) -> Result<Self, String>

Parse the given string as LLVM text IR by copying to create a Module

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a duplicate of the value.

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

Performs copy-assignment from source.