Skip to main content

Function

Struct Function 

Source
pub struct Function {
    pub value: ValueId,
    pub blocks: usize,
    pub instructions: Vec<Instruction>,
    pub first: ValueId,
    pub locals: Vec<Value>,
    pub local_types: Vec<TypeId>,
    pub attachments: Vec<Attachment>,
    pub names: Vec<(ValueId, String)>,
    pub block_names: Vec<(usize, String)>,
    pub block_use_orders: Vec<(usize, Vec<u64>)>,
}
Expand description

A function body.

Fields§

§value: ValueId

The function’s module value id.

§blocks: usize

The number of basic blocks.

§instructions: Vec<Instruction>

The instructions of all blocks, in order.

§first: ValueId

The body’s own values (arguments, constants, instruction results) and their types; their ids start at first, after the module’s values.

§locals: Vec<Value>

The values of the body.

§local_types: Vec<TypeId>

The types of Function::locals.

§attachments: Vec<Attachment>

The metadata attached to the function itself (the attachment records of the body that name no instruction).

§names: Vec<(ValueId, String)>

The body’s symbol table: the names of its values (arguments and instruction results, by absolute id).

§block_names: Vec<(usize, String)>

The names of its basic blocks that have one.

§block_use_orders: Vec<(usize, Vec<u64>)>

The use-list orders of its basic blocks (USELIST_CODE_BB): each block and the position its uses take, in the order LLVM would otherwise keep them (the most recent first). They are the order of its predecessors.

Implementations§

Source§

impl Function

Source

pub fn name(&self, value: ValueId) -> Option<&str>

The body’s name for one of its values, where its symbol table has one.

Source

pub fn block_name(&self, block: usize) -> Option<&str>

The name of a basic block, where it has one.

Trait Implementations§

Source§

impl Clone for Function

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Function

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Function

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Function

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.