Crate rustc_borrowck 

This crate implemens MIR typeck and MIR borrowck.

Re-exports

pub(crate) use borrow_set::LocalsStateAtExit; 🔒

pub(crate) use root_cx::BorrowCheckRootCtxt; 🔒

pub(crate) use crate::borrow_set::BorrowData; 🔒

pub(crate) use crate::borrow_set::BorrowSet; 🔒

pub(crate) use crate::consumers::BodyWithBorrowckFacts; 🔒

pub(crate) use crate::consumers::RustcFacts; 🔒

pub(crate) use crate::dataflow::BorrowIndex; 🔒

pub(crate) use crate::dataflow::Borrowck; 🔒

pub(crate) use crate::dataflow::BorrowckDomain; 🔒

pub(crate) use crate::dataflow::Borrows; 🔒

pub(crate) use crate::diagnostics::AccessKind; 🔒

pub(crate) use crate::diagnostics::BorrowckDiagnosticsBuffer; 🔒

pub(crate) use crate::diagnostics::IllegalMoveOriginKind; 🔒

pub(crate) use crate::diagnostics::MoveError; 🔒

pub(crate) use crate::diagnostics::RegionName; 🔒

pub(crate) use crate::implied_bounds::mir_borrowck_implied_outlives_bounds; 🔒

pub(crate) use crate::place_ext::PlaceExt; 🔒

pub(crate) use crate::places_conflict::PlaceConflictBias; 🔒

pub(crate) use crate::places_conflict::places_conflict; 🔒

pub(crate) use crate::polonius::PoloniusContext; 🔒

pub(crate) use crate::polonius::legacy::PoloniusFacts; 🔒

pub(crate) use crate::polonius::legacy::PoloniusFactsExt; 🔒

pub(crate) use crate::polonius::legacy::PoloniusLocationTable; 🔒

pub(crate) use crate::polonius::legacy::PoloniusOutput; 🔒

pub(crate) use crate::prefixes::PrefixSet; 🔒

pub(crate) use crate::region_infer::RegionInferenceContext; 🔒

pub(crate) use crate::region_infer::opaque_types::DeferredOpaqueTypeError; 🔒

pub(crate) use crate::renumber::RegionCtxt; 🔒

pub(crate) use crate::session_diagnostics::VarNeedNotMut; 🔒

pub(crate) use crate::type_check::free_region_relations::UniversalRegionRelations; 🔒

pub(crate) use crate::type_check::Locations; 🔒

pub(crate) use crate::type_check::MirTypeckRegionConstraints; 🔒

pub(crate) use crate::type_check::MirTypeckResults; 🔒

pub(crate) use self::AccessDepth::Deep; 🔒

pub(crate) use self::AccessDepth::Shallow; 🔒

pub(crate) use self::ReadOrWrite::Activation; 🔒

pub(crate) use self::ReadOrWrite::Read; 🔒

pub(crate) use self::ReadOrWrite::Reservation; 🔒

pub(crate) use self::ReadOrWrite::Write; 🔒

pub(crate) use std::borrow::Cow; 🔒

pub(crate) use OnceCell; 🔒

pub(crate) use RefCell; 🔒

pub(crate) use std::marker::PhantomData; 🔒

pub(crate) use ControlFlow; 🔒

pub(crate) use Deref; 🔒

pub(crate) use std::rc::Rc; 🔒

pub(crate) use polonius_engine::AllFacts; 🔒

pub(crate) use rustc_abi::FieldIdx; 🔒

pub(crate) use rustc_data_structures::frozen::Frozen; 🔒

pub(crate) use FxIndexMap; 🔒

pub(crate) use FxIndexSet; 🔒

pub(crate) use rustc_data_structures::graph::dominators::Dominators; 🔒

pub(crate) use rustc_hir as hir; 🔒

pub(crate) use rustc_hir::CRATE_HIR_ID; 🔒

pub(crate) use rustc_hir::def_id::LocalDefId; 🔒

pub(crate) use rustc_index::bit_set::MixedBitSet; 🔒

pub(crate) use IndexSlice; 🔒

pub(crate) use IndexVec; 🔒

pub(crate) use rustc_infer::infer::outlives::env::RegionBoundPairs; 🔒

pub(crate) use InferCtxt; 🔒

pub(crate) use NllRegionVariableOrigin; 🔒

pub(crate) use RegionVariableOrigin; 🔒

pub(crate) use TyCtxtInferExt; 🔒

pub(crate) use TAIL_EXPR_DROP_ORDER; 🔒

pub(crate) use UNUSED_MUT; 🔒

pub(crate) use rustc_middle::query::Providers; 🔒

pub(crate) use ty; 🔒

pub(crate) use ParamEnv; 🔒

pub(crate) use RegionVid; 🔒

pub(crate) use Ty; 🔒

pub(crate) use TyCtxt; 🔒

pub(crate) use TypeFoldable; 🔒

pub(crate) use TypeVisitable; 🔒

pub(crate) use TypingMode; 🔒

pub(crate) use fold_regions; 🔒

pub(crate) use EverInitializedPlaces; 🔒

pub(crate) use MaybeUninitializedPlaces; 🔒

pub(crate) use InitIndex; 🔒

pub(crate) use InitLocation; 🔒

pub(crate) use LookupResult; 🔒

pub(crate) use MoveData; 🔒

pub(crate) use MovePathIndex; 🔒

pub(crate) use rustc_mir_dataflow::points::DenseLocationMap; 🔒

pub(crate) use Analysis; 🔒

pub(crate) use EntryStates; 🔒

pub(crate) use Results; 🔒

pub(crate) use ResultsVisitor; 🔒

pub(crate) use visit_results; 🔒

pub(crate) use ErrorGuaranteed; 🔒

pub(crate) use Span; 🔒

pub(crate) use Symbol; 🔒

pub(crate) use bug; 🔒

pub(crate) use span_bug; 🔒

pub(crate) use QueryTypeOp; 🔒

pub(crate) use TypeOp; 🔒

pub(crate) use TypeOpOutput; 🔒

pub(crate) use smallvec::SmallVec; 🔒

pub(crate) use debug; 🔒

pub(crate) use instrument; 🔒

pub(crate) use instrument; 🔒

pub(crate) use rustc_middle::mir::*; 🔒

Modules

borrow_set 🔒

borrowck_errors 🔒

constraints 🔒

consumers

A public API provided for the Rust compiler consumers. This file provides API for compiler consumers.

dataflow 🔒

def_use 🔒

diagnostics 🔒

Borrow checker diagnostics.

handle_placeholders 🔒

Logic for lowering higher-kinded outlives constraints (with placeholders and universes) and turn them into regular outlives constraints.

implied_bounds 🔒

nll 🔒

The entry point of the NLL borrow checker.

path_utils 🔒

place_ext 🔒

places_conflict 🔒

The borrowck rules for proving disjointness are applied from the “root” of the borrow forwards, iterating over “similar” projections in lockstep until we can prove overlap one way or another. Essentially, we treat Overlap as a monoid and report a conflict if the product ends up not being Disjoint.

polonius 🔒

Polonius analysis and support code:

prefixes 🔒

From the NLL RFC: “Shallow prefixes are found by stripping away fields, but stop at any dereference. So: writing a path like a is illegal if a.b is borrowed. But: writing a is legal if *a is borrowed, whether or not a is a shared or mutable reference. […] “

region_infer 🔒

renumber 🔒

root_cx 🔒

session_diagnostics 🔒

type_check 🔒

This pass type-checks the MIR to ensure it is not broken.

universal_regions 🔒

Code to extract the universally quantified regions declared on a function. For example:

used_muts 🔒

Structs

BorrowckInferCtxt 🔒

ClosureOutlivesRequirement

Indicates an outlives-constraint between a type or between two free regions declared on the closure.

ClosureOutlivesSubjectTy

Represents a ty::Ty for use in ClosureOutlivesSubject.

ClosureRegionRequirements

After we borrow check a closure, we are left with various requirements that we have inferred between the free regions that appear in the closure’s signature or on its field types. These requirements are then verified and proved by the closure’s creating function. This struct encodes those requirements.

CollectRegionConstraintsResult 🔒

MirBorrowckCtxt 🔒

PropagatedBorrowCheckResults 🔒

Data propagated to the typeck parent by nested items. This should always be empty for the typeck root.

RootPlace 🔒

TyCtxtConsts 🔒

Associate some local constants with the 'tcx lifetime

Enums

AccessDepth 🔒

ArtificialField 🔒

ClosureOutlivesSubject

The subject of a ClosureOutlivesRequirement – that is, the thing that must outlive some region.

InitializationRequiringAction 🔒

LocalMutationIsAllowed 🔒

When checking permissions for a place access, this flag is used to indicate that an immutable local place can be mutated.

Overlap 🔒

The degree of overlap between 2 places for borrow-checking.

ReadKind 🔒

Kind of read access to a value (For informational purposes only)

ReadOrWrite 🔒

Kind of access to a value: read or write (For informational purposes only)

WriteKind 🔒

Kind of write access to a value (For informational purposes only)

Functions

borrow_of_local_data 🔒

Determines if a given borrow is borrowing local data This is called for all Yield expressions on movable coroutines

borrowck_check_region_constraints 🔒

Using the region constraints computed by borrowck_collect_region_constraints and the additional constraints from BorrowCheckRootCtxt::handle_opaque_type_uses, compute the region graph and actually check for any borrowck errors.

borrowck_collect_region_constraints 🔒

Start borrow checking by collecting the region constraints for the current body. This initializes the relevant data structures and then type checks the MIR body.

each_borrow_involving_path 🔒

Encapsulates the idea of iterating over every borrow that involves a particular path

get_flow_results 🔒

is_active 🔒

is_upvar_field_projection 🔒

If place is a field projection, and the field is being projected from a closure type, then returns the index of the field being projected. Note that this closure will always be self in the current MIR, because that is the only time we directly access the fields of a closure type.

mir_borrowck 🔒

Provider for query mir_borrowck. Unlike typeck, this must only be called for typeck roots which similar to typeck will then borrowck all nested bodies as well.

provide

Type Aliases

DeferredClosureRequirements 🔒