Struct llvm_kaleidoscope_rs::llvm::Module

pub struct Module { /* private fields */ }

Wrapper for a LLVM Module with its own LLVM Context.

Implementations

impl<'llvm> Module

pub fn new() -> Self

Create a new Module instance.

Panics

Panics if creating the context or the module fails.

pub fn dump(&self)

Dump LLVM IR emitted into the Module to stdout.

pub fn type_f64(&self) -> Type<'llvm>

Get a type reference representing a f64 float.

Panics

Panics if LLVM API returns a null pointer.

pub fn type_fn(
    &'llvm self,
    args: &mut [Type<'llvm>],
    ret: Type<'llvm>
) -> Type<'llvm>

Get a type reference representing a fn(args) -> ret function.

Panics

Panics if LLVM API returns a null pointer.

pub fn add_fn(&'llvm self, name: &str, fn_type: Type<'llvm>) -> FnValue<'llvm>

Add a function with the given name and fn_type to the module and return a value reference representing the function.

Panics

Panics if LLVM API returns a null pointer or name could not be converted to a SmallCStr.

pub fn get_fn(&'llvm self, name: &str) -> Option<FnValue<'llvm>>

Get a function value reference to the function with the given name if it was previously added to the module with add_fn.

Panics

Panics if name could not be converted to a SmallCStr.

pub fn append_basic_block(
    &'llvm self,
    fn_value: FnValue<'llvm>
) -> BasicBlock<'llvm>

Append a Basic Block to the end of the function referenced by the value reference fn_value.

Panics

Panics if LLVM API returns a null pointer.

pub fn create_basic_block(&self) -> BasicBlock<'llvm>

Create a free-standing Basic Block without adding it to a function. This can be added to a function at a later point in time with FnValue::append_basic_block.

Panics

Panics if LLVM API returns a null pointer.

Trait Implementations

impl Drop for Module

fn drop(&mut self)

Executes the destructor for this type.