Struct miri::CurrentSpan

pub struct CurrentSpan<'a, 'mir, 'tcx> {
    current_frame_idx: Option<usize>,
    tcx: TyCtxt<'tcx>,
    machine: &'a Evaluator<'mir, 'tcx>,
}

A CurrentSpan should be created infrequently (ideally once) per interpreter step. It does nothing on creation, but when CurrentSpan::get is called, searches the current stack for the topmost frame which corresponds to a local crate, and returns the current span in that frame. The result of that search is cached so that later calls are approximately free.

Fields

current_frame_idx: Option<usize>

tcx: TyCtxt<'tcx>

machine: &'a Evaluator<'mir, 'tcx>

Implementations

impl<'a, 'mir: 'a, 'tcx: 'a + 'mir> CurrentSpan<'a, 'mir, 'tcx>

pub fn get(&mut self) -> Span

Get the current span, skipping non-local frames. This function is backed by a cache, and can be assumed to be very fast.

pub fn get_parent(&mut self) -> Span

Similar to CurrentSpan::get, but retrieves the parent frame of the first non-local frame. This is useful when we are processing something which occurs on function-entry and we want to point at the call to the function, not the function definition generally.

fn frame_span(machine: &Evaluator<'_, '_>, idx: usize) -> Span

fn current_frame_idx(&mut self) -> usize

fn compute_current_frame_index(
    tcx: TyCtxt<'_>,
    machine: &Evaluator<'_, '_>
) -> usize

Trait Implementations

impl<'a, 'mir, 'tcx> Clone for CurrentSpan<'a, 'mir, 'tcx>

fn clone(&self) -> CurrentSpan<'a, 'mir, 'tcx>

Returns a copy of the value.

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

Performs copy-assignment from source.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference’s “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes