Module consumers

Expand description

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

Structs§

BodyWithBorrowckFacts: A Body with information computed by the borrow checker. This struct is intended to be consumed by compiler consumers.
BorrowData
BorrowIndex
BorrowSet
BorrowckConsumer 🔒: Struct used during mir borrowck to collect bodies with facts for a typeck root and all its nested bodies.
Borrows: Borrows stores the data used in the analyses that track the flow of borrows.
OutlivesConstraint
PoloniusLocationTable: Maps between a MIR Location, which identifies a particular statement within a basic block, to a “rich location”, which identifies at a finer granularity. In particular, we distinguish the start of a statement and the mid-point. The mid-point is the point just before the statement takes effect; in particular, for an assignment A = B, it is the point where B is about to be written into A. This mid-point is a kind of hack to work around our inability to track the position information at sufficient granularity through outlives relations; however, the rich location table serves another purpose: it compresses locations from multiple words into a single u32.
PoloniusRegionVid: A (kinda) newtype of RegionVid so we can implement Atom on it.
RegionInferenceContext
RustcFacts

ConsumerOptions: Options determining the output behavior of get_bodies_with_borrowck_facts.
PlaceConflictBias: When checking if a place conflicts with another place, this enum is used to influence decisions where a place might be equal or disjoint with another place, such as if a[i] == a[j]. PlaceConflictBias::Overlap would bias toward assuming that i might equal j and that these places overlap. PlaceConflictBias::NoOverlap assumes that for the purposes of the predicate being run in the calling context, the conservative choice is to assume the compared indices are disjoint (and therefore, do not overlap).
RichLocation
TwoPhaseActivation: Location where a two-phase borrow is activated, if a borrow is in fact a two-phase borrow.

calculate_borrows_out_of_scope_at_location
get_bodies_with_borrowck_facts: This function computes borrowck facts for the given def id and all its nested bodies. It must be called with a typeck root which will then borrowck all nested bodies as well. The ConsumerOptions determine which facts are returned. This function makes a copy of the bodies because it needs to regenerate the region identifiers. It should never be invoked during a typical compilation session due to the unnecessary overhead of returning BodyWithBorrowckFacts.
places_conflict: Helper function for checking if places conflict with a mutable borrow and deep access depth. This is used to check for places conflicting outside of the borrow checking code (such as in dataflow).