Struct rustc_borrowck::dataflow::Borrows

source ·
pub struct Borrows<'a, 'mir, 'tcx> {
    tcx: TyCtxt<'tcx>,
    body: &'mir Body<'tcx>,
    borrow_set: &'a BorrowSet<'tcx>,
    borrows_out_of_scope_at_location: FxIndexMap<Location, Vec<BorrowIndex>>,
}
Expand description

Borrows stores the data used in the analyses that track the flow of borrows.

It uniquely identifies every borrow (Rvalue::Ref) by a BorrowIndex, and maps each such index to a BorrowData describing the borrow. These indexes are used for representing the borrows in compact bitvectors.

Fields§

§tcx: TyCtxt<'tcx>§body: &'mir Body<'tcx>§borrow_set: &'a BorrowSet<'tcx>§borrows_out_of_scope_at_location: FxIndexMap<Location, Vec<BorrowIndex>>

Implementations§

source§

impl<'a, 'mir, 'tcx> Borrows<'a, 'mir, 'tcx>

source

pub fn new( tcx: TyCtxt<'tcx>, body: &'mir Body<'tcx>, regioncx: &RegionInferenceContext<'tcx>, borrow_set: &'a BorrowSet<'tcx>, ) -> Self

source

pub fn location(&self, idx: BorrowIndex) -> &Location

source

fn kill_loans_out_of_scope_at_location( &self, trans: &mut impl GenKill<BorrowIndex>, location: Location, )

Add all borrows to the kill set, if those borrows are out of scope at location. That means they went out of a nonlexical scope

source

fn kill_borrows_on_place( &self, trans: &mut impl GenKill<BorrowIndex>, place: Place<'tcx>, )

Kill any borrows that conflict with place.

Trait Implementations§

source§

impl<'tcx> AnalysisDomain<'tcx> for Borrows<'_, '_, 'tcx>

source§

type Domain = BitSet<BorrowIndex>

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

const NAME: &'static str = "borrows"

A descriptive name for this analysis. Used only for debugging. Read more
source§

fn bottom_value(&self, _: &Body<'tcx>) -> Self::Domain

Returns the initial value of the dataflow state upon entry to each basic block.
source§

fn initialize_start_block(&self, _: &Body<'tcx>, _: &mut Self::Domain)

Mutates the initial value of the dataflow state upon entry to the START_BLOCK. Read more
source§

type Direction = Forward

The direction of this analysis. Either Forward or Backward.
source§

impl DebugWithContext<Borrows<'_, '_, '_>> for BorrowIndex

source§

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

source§

fn fmt_diff_with( &self, old: &Self, ctxt: &C, f: &mut Formatter<'_>, ) -> Result<(), Error>

Print the difference between self and old. Read more
source§

impl<'tcx> GenKillAnalysis<'tcx> for Borrows<'_, '_, 'tcx>

Forward dataflow computation of the set of borrows that are in scope at a particular location.

  • we gen the introduced loans
  • we kill loans on locals going out of (regular) scope
  • we kill the loans going out of their region’s NLL scope: in NLL terms, the frontier where a region stops containing the CFG points reachable from the issuing location.
  • we also kill loans of conflicting places when overwriting a shared path: e.g. borrows of a.b.c when a is overwritten.
source§

type Idx = BorrowIndex

source§

fn domain_size(&self, _: &Body<'tcx>) -> usize

source§

fn before_statement_effect( &mut self, trans: &mut impl GenKill<Self::Idx>, _statement: &Statement<'tcx>, location: Location, )

See Analysis::apply_before_statement_effect. Note how the second arg differs.
source§

fn statement_effect( &mut self, trans: &mut impl GenKill<Self::Idx>, stmt: &Statement<'tcx>, location: Location, )

See Analysis::apply_statement_effect. Note how the second arg differs.
source§

fn before_terminator_effect( &mut self, trans: &mut Self::Domain, _terminator: &Terminator<'tcx>, location: Location, )

See Analysis::apply_before_terminator_effect.
source§

fn terminator_effect<'mir>( &mut self, trans: &mut Self::Domain, terminator: &'mir Terminator<'tcx>, _location: Location, ) -> TerminatorEdges<'mir, 'tcx>

See Analysis::apply_terminator_effect.
source§

fn call_return_effect( &mut self, _trans: &mut Self::Domain, _block: BasicBlock, _return_places: CallReturnPlaces<'_, 'tcx>, )

See Analysis::apply_call_return_effect.
source§

fn switch_int_edge_effects<G>( &mut self, _block: BasicBlock, _discr: &Operand<'tcx>, _edge_effects: &mut impl SwitchIntEdgeEffects<G>, )
where G: GenKill<Self::Idx>,

See Analysis::apply_switch_int_edge_effects.

Auto Trait Implementations§

§

impl<'a, 'mir, 'tcx> Freeze for Borrows<'a, 'mir, 'tcx>

§

impl<'a, 'mir, 'tcx> !RefUnwindSafe for Borrows<'a, 'mir, 'tcx>

§

impl<'a, 'mir, 'tcx> !Send for Borrows<'a, 'mir, 'tcx>

§

impl<'a, 'mir, 'tcx> !Sync for Borrows<'a, 'mir, 'tcx>

§

impl<'a, 'mir, 'tcx> Unpin for Borrows<'a, 'mir, 'tcx>

§

impl<'a, 'mir, 'tcx> !UnwindSafe for Borrows<'a, 'mir, 'tcx>

Blanket Implementations§

source§

impl<T> Aligned for T

source§

const ALIGN: Alignment = _

Alignment of Self.
source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

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

source§

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<_>>()).

source§

type Output = R

source§

impl<T> Filterable for T

source§

fn filterable( self, filter_name: &'static str, ) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>

Creates a filterable data provider with the given name for debugging. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

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> IntoEither for T

source§

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
source§

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
source§

impl<P> IntoQueryParam<P> for P

source§

impl<T> MaybeResult<T> for T

source§

type Error = !

source§

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

source§

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

source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

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

source§

type Error = Infallible

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

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

Performs the conversion.
source§

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

source§

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

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

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

Performs the conversion.
source§

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

source§

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

source§

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

source§

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

source§

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

source§

fn vzip(self) -> V

source§

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

source§

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

source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<'a, T> Captures<'a> for T
where T: ?Sized,

source§

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

source§

impl<T> MaybeSendSync for T

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: 80 bytes