Struct llvm_rs::Builder

pub struct Builder(_);

This provides a uniform API for creating instructions and inserting them into a basic block.

Implementations

impl Builder

pub fn new(context: &Context) -> CSemiBox<'_, Builder>

Create a new builder in the context given.

pub fn position_at_end(&self, block: &BasicBlock)

Position the builder at the end of block.

pub fn build_ret_void(&self) -> &Value

Build an instruction that returns from the function with void.

pub fn build_ret(&self, value: &Value) -> &Value

Build an instruction that returns from the function with value.

pub fn build_array_alloca(&self, elem: &Type, size: &Value) -> &Value

Build an instruction that allocates an array with the element type elem and the size size.

The size of this array will be the size of elem times size.

pub fn build_alloca(&self, ty: &Type) -> &Value

Build an instruction that allocates a pointer to fit the size of ty then returns this pointer.

Make sure to call build_free with the pointer value when you’re done with it, or you’re gonna have a bad time.

pub fn build_free(&self, val: &Value) -> &Value

Build an instruction that frees the val, which MUST be a pointer that was returned from build_alloca.

pub fn build_store(&self, val: &Value, ptr: &Value) -> &Value

Build an instruction that store the value val in the pointer ptr.

pub fn build_br(&self, dest: &BasicBlock) -> &Value

Build an instruction that branches to the block dest.

pub fn get_insert_block<'a>(&self) -> &'a BasicBlock

pub fn build_cond_br(
    &self,
    cond: &Value,
    if_block: &BasicBlock,
    else_block: &BasicBlock
) -> &Value

Build an instruction that branches to if_block if cond evaluates to true, and else_block otherwise.

pub fn build_call(&self, func: &Function, args: &[&Value]) -> &Value

Build an instruction that calls the function func with the arguments args.

This will return the return value of the function.

pub fn build_tail_call(&self, func: &Function, args: &[&Value]) -> &Value

Build an instruction that calls the function func with the arguments args.

This will return the return value of the function.

pub fn build_fp_to_si(&self, val: &Value, dest: &Type) -> &Value

Build an instruction that converts val to a floating point dest.

pub fn build_si_to_fp(&self, val: &Value, dest: &Type) -> &Value

Build an instruction that converts val to an integer dest.

pub fn build_select(
    &self,
    cond: &Value,
    true_val: &Value,
    false_val: &Value
) -> &Value

Build an instruction that yields to true_val if cond is equal to 1, and false_val otherwise.

pub fn build_bit_cast(&self, value: &Value, dest: &Type) -> &Value

Build an instruction that casts a value into a certain type.

pub fn build_int_to_ptr(&self, val: &Value, dest: &Type) -> &Value

Build an instruction that casts an integer to a pointer.

pub fn build_ptr_to_int(&self, val: &Value, dest: &Type) -> &Value

Build an instruction that casts a pointer to an integer.

pub fn build_zext(&self, value: &Value, dest: &Type) -> &Value

Build an instruction that zero extends its operand to the type dest.

pub fn build_trunc(&self, value: &Value, dest: &Type) -> &Value

Build an instruction that truncates the high-order bits of value to fit into a certain type.

pub fn build_insert_value(&self, agg: &Value, elem: &Value, index: usize) -> &Value

Build an instruction that inserts a value into an aggregate data value.

pub fn build_gep(&self, pointer: &Value, indices: &[&Value]) -> &Value

Build an instruction that computes the address of a subelement of an aggregate data structure.

Basically type-safe pointer arithmetic.

pub fn build_switch(
    &self,
    value: &Value,
    default: &BasicBlock,
    cases: &[(&Value, &BasicBlock)]
) -> &Value

Build an instruction that runs whichever block matches the value, or default if none of them matched it.

pub fn build_phi<'ctx>(
    &self,
    ty: &'ctx Type,
    entries: &[(&'ctx Value, &'ctx BasicBlock)]
) -> &'ctx Value

Build a phi node which is used together with branching to select a value depending on the predecessor of the current block

pub fn build_load(&self, value: &Value) -> &Value

pub fn build_neg(&self, value: &Value) -> &Value

pub fn build_not(&self, value: &Value) -> &Value

pub fn build_add(&self, left: &Value, right: &Value) -> &Value

pub fn build_sub(&self, left: &Value, right: &Value) -> &Value

pub fn build_mul(&self, left: &Value, right: &Value) -> &Value

pub fn build_div(&self, left: &Value, right: &Value) -> &Value

pub fn build_shl(&self, left: &Value, right: &Value) -> &Value

pub fn build_ashr(&self, left: &Value, right: &Value) -> &Value

pub fn build_and(&self, left: &Value, right: &Value) -> &Value

pub fn build_or(&self, left: &Value, right: &Value) -> &Value

pub fn build_xor(&self, left: &Value, right: &Value) -> &Value

pub fn build_rem(&self, left: &Value, right: &Value) -> &Value

pub fn build_cmp(&self, a: &Value, b: &Value, pred: Predicate) -> &Value

Build an instruction to compare two values with the predicate given.

Trait Implementations

impl DisposeRef for Builder

type RefTo = LLVMBuilder

What a reference to this type represents as a C pointer.

unsafe fn dispose(ptr: *mut LLVMBuilder)

Destroy the contents at the pointer’s location.

impl<'a> From<&'a Builder> for LLVMBuilderRef

fn from(ty: &'a Builder) -> LLVMBuilderRef

Converts to this type from the input type.

impl<'a> From<&'a mut Builder> for LLVMBuilderRef

fn from(ty: &'a mut Builder) -> LLVMBuilderRef

Converts to this type from the input type.

impl<'a> From<*mut LLVMBuilder> for &'a Builder

fn from(ty: LLVMBuilderRef) -> &'a Builder

Converts to this type from the input type.

impl<'a> From<*mut LLVMBuilder> for &'a mut Builder

fn from(ty: LLVMBuilderRef) -> &'a mut Builder

Converts to this type from the input type.

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

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

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