## Frame

# Struct Frame

Source

    pub struct Frame<'tcx, Prov: Provenance = CtfeProvenance, Extra = ()> {
        pub(super) body: &'tcx Body<'tcx>,
        pub(super) instance: Instance<'tcx>,
        pub extra: Extra,
        return_cont: ReturnContinuation,
        pub return_place: PlaceTy<'tcx, Prov>,
        pub locals: IndexVec<Local, LocalState<'tcx, Prov>>,
        tracing_span: SpanGuard,
        pub(super) loc: Either<Location, Span>,
    }

Expand description

A stack frame.

## Fields§

§`body: &'tcx Body<'tcx>`

The MIR for the function called on this frame.

§`instance: Instance<'tcx>`

The def_id and args of the current function.

§`extra: Extra`

Extra data for the machine.

§`return_cont: ReturnContinuation`

Where to continue 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. This place is to be interpreted relative to the caller’s stack frame. We use a `PlaceTy` instead of an `MPlaceTy` since this avoids having to move all return places into Miri’s memory.

§`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: Either<Location, Span>`

If this is `Right`, 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).

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

## Implementations§

Source§

### impl<'tcx, Prov: Provenance> Frame<'tcx, Prov>

Source

#### pub fn with_extra<Extra>(self, extra: Extra) -> Frame<'tcx, Prov, Extra>

Source§

### impl<'tcx, Prov: Provenance, Extra> Frame<'tcx, Prov, Extra>

Source

#### pub fn current_loc(&self) -> Either<Location, Span>

Get the current location within the Frame.

If this is `Right`, 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).

Used by priroda.

Source

#### pub fn body(&self) -> &'tcx Body<'tcx>

Source

#### pub fn instance(&self) -> Instance<'tcx>

Source

#### pub fn current_source_info(&self) -> Option<&SourceInfo>

Return the `SourceInfo` of the current instruction.

Source

#### pub fn current_span(&self) -> Span

Source

#### pub fn lint_root(&self, tcx: TyCtxt<'tcx>) -> Option<HirId>

Source

#### pub(super) fn locals_addr(&self) -> usize

Returns the address of the buffer where the locals are stored. This is used by `Place` as a sanity check to detect bugs where we mix up which stack frame a place refers to.

Source

#### pub fn generate_stacktrace_from_stack(stack: &[Self]) -> Vec<FrameInfo<'tcx>>

## Auto Trait Implementations§

§

### impl<'tcx, Prov = CtfeProvenance, Extra = ()> !DynSend for Frame<'tcx, Prov, Extra>

§

### impl<'tcx, Prov = CtfeProvenance, Extra = ()> !DynSync for Frame<'tcx, Prov, Extra>

§

### impl<'tcx, Prov, Extra> Freeze for Frame<'tcx, Prov, Extra>
where Extra: Freeze, Prov: Freeze,

§

### impl<'tcx, Prov = CtfeProvenance, Extra = ()> !RefUnwindSafe for Frame<'tcx, Prov, Extra>

§

### impl<'tcx, Prov = CtfeProvenance, Extra = ()> !Send for Frame<'tcx, Prov, Extra>

§

### impl<'tcx, Prov = CtfeProvenance, Extra = ()> !Sync for Frame<'tcx, Prov, Extra>

§

### impl<'tcx, Prov, Extra> Unpin for Frame<'tcx, Prov, Extra>
where Extra: Unpin, Prov: Unpin,

§

### impl<'tcx, Prov = CtfeProvenance, Extra = ()> !UnwindSafe for Frame<'tcx, Prov, Extra>

## Blanket Implementations§

§

### impl<T> Aligned for T

§

#### const ALIGN: Alignment

Alignment of `Self`.
§

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

§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
§

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

§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

### impl<T, R> CollectAndApply<T, R> for T

§

#### fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to `f(&iter.collect::<Vec<_>>())`.

§

#### type Output = R

§

### impl<T> From<T> for T

§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
§

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

§

#### fn into(self) -> U

Calls `U::from(self)`.

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

§

### impl<T> IntoEither for T

§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
§

### impl<P> IntoQueryParam<P> for P

§

#### fn into_query_param(self) -> P

§

### impl<T> MaybeResult<T> for T

§

#### type Error = !

§

#### fn from(_: Result<T, <T as MaybeResult<T>>::Error>) -> T

§

#### fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>

§

### impl<T> Pointable for T

§

#### const ALIGN: usize

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

### impl<T> Same for T

§

#### type Output = T

Should always be `Self`
§

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

§

#### type Error = Infallible

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

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.
§

### impl<I, T, U> Upcast<I, U> for T
where U: UpcastFrom<I, T>,

§

#### fn upcast(self, interner: I) -> U

§

### impl<I, T> UpcastFrom<I, T> for T

§

#### fn upcast_from(from: T, _tcx: I) -> T

§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<Tcx, T> Value<Tcx> for T
where Tcx: DepContext,

§

#### default fn from_cycle_error( tcx: Tcx, cycle_error: &CycleError, _guar: ErrorGuaranteed, ) -> T

§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
§

### impl<T> ErasedDestructor for T
where T: 'static,

## 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.