Struct llvm_kaleidoscope_rs::llvm::FnValue

pub struct FnValue<'llvm>(/* private fields */);

Wrapper for a LLVM Value Reference specialized for contexts where function values are needed.

Implementations

impl<'llvm> FnValue<'llvm>

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

Get a type reference representing the function type (return + args) of the given function value.

Panics

Panics if LLVM API returns a null pointer.

pub fn args(&self) -> usize

Get the number of function arguments for the given function value.

pub fn arg(&self, idx: usize) -> Value<'llvm>

Get a value reference for the function argument at index idx.

Panics

Panics if LLVM API returns a null pointer or indexed out of bounds.

pub fn basic_blocks(&self) -> usize

Get the number of Basic Blocks for the given function value.

pub fn append_basic_block(&self, bb: BasicBlock<'llvm>)

Append a Basic Block to the end of the function value.

pub fn verify(&self) -> bool

Verify that the given function is valid.

Methods from Deref<Target = Value<'llvm>>

pub fn dump(&self)

Dump the LLVM Value to stdout.

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

Get a type reference representing for the given value reference.

Panics

Panics if LLVM API returns a null pointer.

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

Set the name for the given value reference.

Panics

Panics if LLVM API returns a null pointer.

pub fn get_name(&self) -> &'llvm str

Get the name for the given value reference.

Panics

Panics if LLVM API returns a null pointer.

pub fn is_f64(&self) -> bool

Check if value is of f64 type.

pub fn is_int(&self) -> bool

Check if value is of integer type.

Trait Implementations

impl<'llvm> Clone for FnValue<'llvm>

fn clone(&self) -> FnValue<'llvm>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'llvm> Deref for FnValue<'llvm>

type Target = Value<'llvm>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'llvm> Copy for FnValue<'llvm>