[][src]Struct rustc_mir::dataflow::impls::MaybeBorrowedLocals

pub struct MaybeBorrowedLocals<K = AnyBorrow> {
    kind: K,
    ignore_borrow_on_drop: bool,

A dataflow analysis that tracks whether a pointer or reference could possibly exist that points to a given local.

The K parameter determines what kind of borrows are tracked. By default, MaybeBorrowedLocals looks for any borrow of a local. If you are only interested in borrows that might allow mutation, use the MaybeMutBorrowedLocals type alias instead.

At present, this is used as a very limited form of alias analysis. For example, MaybeBorrowedLocals is used to compute which locals are live during a yield expression for immovable generators. MaybeMutBorrowedLocals is used during const checking to prove that a local has not been mutated via indirect assignment (e.g., *p = 42), the side-effects of a function call or inline assembly.


kind: Kignore_borrow_on_drop: bool


impl MaybeBorrowedLocals[src]

pub fn all_borrows() -> Self[src]

A dataflow analysis that records whether a pointer or reference exists that may alias the given local.

impl<'mir, 'tcx> MaybeBorrowedLocals<MutBorrow<'mir, 'tcx>>[src]

pub fn mut_borrows_only(
    tcx: TyCtxt<'tcx>,
    body: &'mir Body<'tcx>,
    param_env: ParamEnv<'tcx>
) -> Self

A dataflow analysis that records whether a pointer or reference exists that may mutably alias the given local.

This includes &mut and pointers derived from an &mut, as well as shared borrows of types with interior mutability.

impl<K> MaybeBorrowedLocals<K>[src]

pub fn unsound_ignore_borrow_on_drop(self) -> Self[src]

During dataflow analysis, ignore the borrow that may occur when a place is dropped.

Drop terminators may call custom drop glue (Drop::drop), which takes &mut self as a parameter. In the general case, a drop impl could launder that reference into the surrounding environment through a raw pointer, thus creating a valid *mut pointing to the dropped local. We are not yet willing to declare this particular case UB, so we must treat all dropped locals as mutably borrowed for now. See discussion on #61069.

In some contexts, we know that this borrow will never occur. For example, during const-eval, custom drop glue cannot be run. Code that calls this should document the assumptions that justify ignoring Drop terminators in this way.

pub(in dataflow::impls::borrowed_locals) fn transfer_function<'a, T>(
    &'a self,
    trans: &'a mut T
) -> TransferFunction<'a, T, K>

Trait Implementations

impl<K, 'tcx> AnalysisDomain<'tcx> for MaybeBorrowedLocals<K> where
    K: BorrowAnalysisKind<'tcx>, 

type Domain = BitSet<Local>

The type that holds the dataflow state at any given point in the program.

impl<K, 'tcx> GenKillAnalysis<'tcx> for MaybeBorrowedLocals<K> where
    K: BorrowAnalysisKind<'tcx>, 

type Idx = Local

Auto Trait Implementations

impl<K> RefUnwindSafe for MaybeBorrowedLocals<K> where
    K: RefUnwindSafe

impl<K> Send for MaybeBorrowedLocals<K> where
    K: Send

impl<K> Sync for MaybeBorrowedLocals<K> where
    K: Sync

impl<K> Unpin for MaybeBorrowedLocals<K> where
    K: Unpin

impl<K> UnwindSafe for MaybeBorrowedLocals<K> where
    K: UnwindSafe

Blanket Implementations

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

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

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

impl<T> From<T> for T[src]

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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.

impl<T> WithConstness for T[src]