Struct AnalysisStateGuardMut 

pub struct AnalysisStateGuardMut<'a, T: AnalysisState + 'static> { /* private fields */ }

A mutable handle/guard for some analysis state T

Implementations

impl<'a, T: AnalysisState + 'static> AnalysisStateGuardMut<'a, T>

pub fn freeze(guard: Self) -> AnalysisStateGuard<'a, T>

pub fn into_entity_ref(guard: Self) -> EntityRef<'a, T>

Consume the guard and convert the underlying mutable borrow of the state into an immutable borrow, after propagating any changes made to the state while mutating it. When this function returns, the state can be safely aliased by immutable references, while the caller retains the ability to interact with the state via the returned [crate::EntityRef].

pub fn change<F>(&mut self, callback: F) -> ChangeResult

where F: FnOnce(&mut T) -> ChangeResult,

Apply a function to the underlying AnalysisState that may or may not change it.

The callback is expected to return a ChangeResult reflecting whether or not changes were applied. If the callback fails to signal that a change was made, dependent analyses will not be re-enqueued, and thus analyses may make incorrect assumptions.

This should be used when you need a mutable reference to the state, but may not actually end up mutating the state with it. The default [DerefMut] implementation will always assume the underlying state was changed if invoked - this function lets you bypass that, but with the requirement that you signal changes manually.

pub fn subscribe<A>(guard: &Self, analysis: &A)

where A: DataFlowAnalysis + 'static,

Subscribe analysis to any changes of the lattice anchor.

This is handled by invoking the AnalysisStateSubscriptionBehavior::on_subscribe callback, leaving the handling for ad-hoc subscriptions of this kind to each AnalysisState implementation.

Safety

The caller must ensure that analysis is owned by the [DataFlowSolver], as that is the only situation in which it is safe for us to take the address of the analysis for later use.

Trait Implementations

impl<T: AnalysisState> AnalysisState for AnalysisStateGuardMut<'_, T>

fn as_any(&self) -> &dyn Any

fn anchor(&self) -> &dyn LatticeAnchor

fn type_name(&self) -> &'static str

impl<T: AnalysisState> AsMut<T> for AnalysisStateGuardMut<'_, T>

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T: AnalysisState> AsRef<T> for AnalysisStateGuardMut<'_, T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: AnalysisState + Debug> Debug for AnalysisStateGuardMut<'_, T>

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

Formats the value using the given formatter.

impl<T: DenseLattice> DenseLattice for AnalysisStateGuardMut<'_, T>

type Lattice = <T as DenseLattice>::Lattice

fn lattice(&self) -> &Self::Lattice

fn lattice_mut(&mut self) -> &mut Self::Lattice

fn join(&mut self, rhs: &Self::Lattice) -> ChangeResult

fn meet(&mut self, rhs: &Self::Lattice) -> ChangeResult

impl<T: AnalysisState> Deref for AnalysisStateGuardMut<'_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: AnalysisState> DerefMut for AnalysisStateGuardMut<'_, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: AnalysisState + Display> Display for AnalysisStateGuardMut<'_, T>

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

Formats the value using the given formatter.

impl<T: AnalysisState + 'static> Drop for AnalysisStateGuardMut<'_, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: SparseLattice> SparseLattice for AnalysisStateGuardMut<'_, T>

type Lattice = <T as SparseLattice>::Lattice

fn lattice(&self) -> &Self::Lattice

Get the underlying lattice value

fn join(&mut self, rhs: &Self::Lattice) -> ChangeResult

Join rhs with self, returning whether or not a change was made

fn meet(&mut self, rhs: &Self::Lattice) -> ChangeResult

Meet rhs with self, returning whether or not a change was made