pub struct Frame<'mir, 'tcx, Prov = AllocId, Extra = ()>where
    Prov: Provenance,
{ pub body: &'mir Body<'tcx>, pub instance: Instance<'tcx>, pub extra: Extra, pub return_to_block: StackPopCleanup, pub return_place: PlaceTy<'tcx, Prov>, pub locals: IndexVec<Local, LocalState<'tcx, Prov>>, tracing_span: SpanGuard, pub loc: Result<Location, Span>, }
Expand description

A stack frame.

Fields

body: &'mir Body<'tcx>

The MIR for the function called on this frame.

instance: Instance<'tcx>

The def_id and substs of the current function.

extra: Extra

Extra data for the machine.

return_to_block: StackPopCleanup

Work to perform when returning from this function.

return_place: PlaceTy<'tcx, Prov>

The location where the result of the current stack frame should be written to, and its layout in the caller.

locals: IndexVec<Local, LocalState<'tcx, Prov>>

The list of locals for this stack frame, stored in order as [return_ptr, arguments..., variables..., temporaries...]. The locals are stored as Option<Value>s. None represents a local that is currently dead, while a live local can either directly contain Scalar or refer to some part of an Allocation.

Do not access this directly; always go through the machine hook!

tracing_span: SpanGuard

The span of the tracing crate is stored here. When the guard is dropped, the span is exited. This gives us a full stack trace on all tracing statements.

loc: Result<Location, Span>

If this is Err, we are not currently executing any particular statement in this frame (can happen e.g. during frame initialization, and during unwinding on frames without cleanup code). We basically abuse Result as Either.

Needs to be public because ConstProp does unspeakable things to it.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.