Struct MirFunction

pub struct MirFunction {
    pub name: String,
    pub arity: usize,
    pub return_ty: Ty,
    pub locals: PrimaryMap<MirLocalId, LocalInfo>,
    pub params: Vec<MirLocalId>,
    pub param_modes: Vec<MirOwnershipMode>,
    pub entry: MirBlockId,
    pub blocks: PrimaryMap<MirBlockId, MirBlock>,
}

Function-level MIR in CFG form.

• params are function parameter locals.
• param_modes mirrors source ownership modes for parameters.
• entry is the first block reached for execution.

Fields

name: String

User-visible function or field name.

arity: usize

Number of source parameters accepted by the function.

return_ty: Ty

Semantic return type of the function.

locals: PrimaryMap<MirLocalId, LocalInfo>

Local metadata arena for function values.

params: Vec<MirLocalId>

Local ids corresponding to incoming parameters.

param_modes: Vec<MirOwnershipMode>

Ownership modes for each incoming parameter.

entry: MirBlockId

Entry block id for the function CFG.

blocks: PrimaryMap<MirBlockId, MirBlock>

CFG blocks stored for the function.

Implementations

impl MirFunction

pub fn param_binding(&self, index: usize) -> MirParamBinding<'_>

Return metadata for one parameter by index.

pub fn param_bindings(&self) -> impl Iterator<Item = MirParamBinding<'_>> + '_

Iterate over source parameters with normalized query helpers.

pub fn local_info(&self, local_id: MirLocalId) -> &LocalInfo

Return metadata for one local.

pub fn call_arg_binding<'a>( &'a self, arg: &'a MirCallArg, ) -> MirCallArgBinding<'a>

Return normalized metadata for one call argument.

pub fn assert_valid(&self)

Assert internal MIR invariants needed by downstream backends.

fn assert_edge_args_compatible( &self, params: &[MirLocalId], args: &[MirLocalId], edge_kind: &'static str, )

Assert that edge arguments match the target block parameter contract.

fn assert_instr_valid(&self, instr: &MirInstr)

Assert per-instruction MIR invariants.

fn assert_call_args_valid(&self, args: &[MirCallArg])

Assert call argument invariants that are backend-independent.

Trait Implementations

impl Clone for MirFunction

fn clone(&self) -> MirFunction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MirFunction

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

Formats the value using the given formatter.