pub struct ResultsCursor<'mir, 'tcx, A, R = Results<'tcx, A>>where
    A: Analysis<'tcx>,
{ body: &'mir Body<'tcx>, results: R, state: A::Domain, pos: CursorPosition, state_needs_reset: bool, reachable_blocks: BitSet<BasicBlock>, }
Expand description

Allows random access inspection of the results of a dataflow analysis.

This cursor only has linear performance within a basic block when its statements are visited in the same order as the DIRECTION of the analysis. In the worst case—when statements are visited in reverse order—performance will be quadratic in the number of statements in the block. The order in which basic blocks are inspected has no impact on performance.

A ResultsCursor can either own (the default) or borrow the dataflow results it inspects. The type of ownership is determined by R (see ResultsRefCursor above).

Fields§

§body: &'mir Body<'tcx>§results: R§state: A::Domain§pos: CursorPosition§state_needs_reset: bool

Indicates that state has been modified with a custom effect.

When this flag is set, we need to reset to an entry set before doing a seek.

§reachable_blocks: BitSet<BasicBlock>

Implementations§

source§

impl<'mir, 'tcx, A, R> ResultsCursor<'mir, 'tcx, A, R>where
    A: Analysis<'tcx>,
    R: Borrow<Results<'tcx, A>>,

source

pub fn new(body: &'mir Body<'tcx>, results: R) -> Self

Returns a new cursor that can inspect results.

source

pub fn results(&self) -> &Results<'tcx, A>

Returns the underlying Results.

source

pub fn analysis(&self) -> &A

Returns the Analysis used to generate the underlying Results.

source

pub fn get(&self) -> &A::Domain

Returns the dataflow state at the current location.

source

pub(super) fn seek_to_block_entry(&mut self, block: BasicBlock)

Resets the cursor to hold the entry set for the given basic block.

For forward dataflow analyses, this is the dataflow state prior to the first statement.

For backward dataflow analyses, this is the dataflow state after the terminator.

source

pub fn seek_to_block_start(&mut self, block: BasicBlock)

Resets the cursor to hold the state prior to the first statement in a basic block.

For forward analyses, this is the entry set for the given block.

For backward analyses, this is the state that will be propagated to its predecessors (ignoring edge-specific effects).

source

pub fn seek_to_block_end(&mut self, block: BasicBlock)

Resets the cursor to hold the state after the terminator in a basic block.

For backward analyses, this is the entry set for the given block.

For forward analyses, this is the state that will be propagated to its successors (ignoring edge-specific effects).

source

pub fn seek_before_primary_effect(&mut self, target: Location)

Advances the cursor to hold the dataflow state at target before its “primary” effect is applied.

The “before” effect at the target location will be applied.

source

pub fn seek_after_primary_effect(&mut self, target: Location)

Advances the cursor to hold the dataflow state at target after its “primary” effect is applied.

The “before” effect at the target location will be applied as well.

source

fn seek_after(&mut self, target: Location, effect: Effect)

source

pub fn apply_custom_effect(&mut self, f: impl FnOnce(&A, &mut A::Domain))

Applies f to the cursor’s internal state.

This can be used, e.g., to apply the call return effect directly to the cursor without creating an extra copy of the dataflow state.

source§

impl<'mir, 'tcx, A, R> ResultsCursor<'mir, 'tcx, A, R>where
    A: GenKillAnalysis<'tcx>,
    A::Domain: BitSetExt<A::Idx>,
    R: Borrow<Results<'tcx, A>>,

source

pub fn contains(&self, elem: A::Idx) -> bool

Auto Trait Implementations§

§

impl<'mir, 'tcx, A, R = Results<'tcx, A>> !RefUnwindSafe for ResultsCursor<'mir, 'tcx, A, R>

§

impl<'mir, 'tcx, A, R = Results<'tcx, A>> !Send for ResultsCursor<'mir, 'tcx, A, R>

§

impl<'mir, 'tcx, A, R = Results<'tcx, A>> !Sync for ResultsCursor<'mir, 'tcx, A, R>

§

impl<'mir, 'tcx, A, R> Unpin for ResultsCursor<'mir, 'tcx, A, R>where
    R: Unpin,
    <A as AnalysisDomain<'tcx>>::Domain: Unpin,
    'tcx: 'mir,

§

impl<'mir, 'tcx, A, R = Results<'tcx, A>> !UnwindSafe for ResultsCursor<'mir, 'tcx, A, R>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · 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, U> TryFrom<U> for Twhere
    U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::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.