Enum rustc_middle::mir::syntax::FakeReadCause

pub enum FakeReadCause {
    ForMatchGuard,
    ForMatchedPlace(Option<LocalDefId>),
    ForGuardBinding,
    ForLet(Option<LocalDefId>),
    ForIndex,
}

The FakeReadCause describes the type of pattern why a FakeRead statement exists.

Variants

ForMatchGuard

Inject a fake read of the borrowed input at the end of each guards code.

This should ensure that you cannot change the variant for an enum while you are in the midst of matching on it.

ForMatchedPlace(Option<LocalDefId>)

let x: !; match x {} doesn’t generate any read of x so we need to generate a read of x to check that it is initialized and safe.

If a closure pattern matches a Place starting with an Upvar, then we introduce a FakeRead for that Place outside the closure, in such a case this option would be Some(closure_def_id). Otherwise, the value of the optional LocalDefId will be None.

ForGuardBinding

A fake read of the RefWithinGuard version of a bind-by-value variable in a match guard to ensure that its value hasn’t change by the time we create the OutsideGuard version.

ForLet(Option<LocalDefId>)

Officially, the semantics of

let pattern = <expr>;

is that <expr> is evaluated into a temporary and then this temporary is into the pattern.

However, if we see the simple pattern let var = <expr>, we optimize this to evaluate <expr> directly into the variable var. This is mostly unobservable, but in some cases it can affect the borrow checker, as in #53695. Therefore, we insert a “fake read” here to ensure that we get appropriate errors.

If a closure pattern matches a Place starting with an Upvar, then we introduce a FakeRead for that Place outside the closure, in such a case this option would be Some(closure_def_id). Otherwise, the value of the optional DefId will be None.

ForIndex

If we have an index expression like

(*x)[1][{ x = y; 4}]

then the first bounds check is invalidated when we evaluate the second index expression. Thus we create a fake borrow of x across the second indexer, which will cause a borrow check error.

Trait Implementations

impl Clone for FakeReadCause

fn clone(&self) -> FakeReadCause

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FakeReadCause

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

Formats the value using the given formatter.

impl<'tcx, __D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<__D> for FakeReadCause

fn decode(__decoder: &mut __D) -> Self

impl<'tcx, __E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<__E> for FakeReadCause

fn encode(&self, __encoder: &mut __E)

impl Hash for FakeReadCause

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl<'__ctx> HashStable<StableHashingContext<'__ctx>> for FakeReadCause

fn hash_stable(
    &self,
    __hcx: &mut StableHashingContext<'__ctx>,
    __hasher: &mut StableHasher
)

impl<'tcx> Lift<'tcx> for FakeReadCause

type Lifted = FakeReadCause

fn lift_to_tcx(self, _: TyCtxt<'tcx>) -> Option<Self>

impl PartialEq<FakeReadCause> for FakeReadCause

fn eq(&self, other: &FakeReadCause) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'tcx> TypeFoldable<'tcx> for FakeReadCause

fn try_fold_with<F: FallibleTypeFolder<'tcx>>(
    self,
    _: &mut F
) -> Result<FakeReadCause, F::Error>

The entry point for folding. To fold a value t with a folder f call: t.try_fold_with(f).

fn fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Self

A convenient alternative to try_fold_with for use with infallible folders. Do not override this method, to ensure coherence with try_fold_with.

impl<'tcx> TypeVisitable<'tcx> for FakeReadCause

fn visit_with<F: TypeVisitor<'tcx>>(&self, _: &mut F) -> ControlFlow<F::BreakTy>

The entry point for visiting. To visit a value t with a visitor v call: t.visit_with(v).

fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool

Returns true if self has any late-bound regions that are either bound by binder or bound by some binder outside of binder. If binder is ty::INNERMOST, this indicates whether there are any late-bound regions that appear free.

fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool

Returns true if this self has any regions that escape binder (and hence are not bound by it).

fn has_escaping_bound_vars(&self) -> bool

fn has_type_flags(&self, flags: TypeFlags) -> bool

fn has_projections(&self) -> bool

fn has_opaque_types(&self) -> bool

fn references_error(&self) -> bool

fn error_reported(&self) -> Option<ErrorGuaranteed>

fn has_param_types_or_consts(&self) -> bool

fn has_infer_regions(&self) -> bool

fn has_infer_types(&self) -> bool

fn has_infer_types_or_consts(&self) -> bool

fn needs_infer(&self) -> bool

fn has_placeholders(&self) -> bool

fn needs_subst(&self) -> bool

fn has_free_regions(&self) -> bool

“Free” regions in this context means that it has any region that is not (a) erased or (b) late-bound.

fn has_erased_regions(&self) -> bool

fn has_erasable_regions(&self) -> bool

True if there are any un-erased free regions.

fn is_global(&self) -> bool

Indicates whether this value references only ‘global’ generic parameters that are the same regardless of what fn we are in. This is used for caching.

fn has_late_bound_regions(&self) -> bool

True if there are any late-bound regions

fn still_further_specializable(&self) -> bool

Indicates whether this value still has parameters/placeholders/inference variables which could be replaced later, in a way that would change the results of impl specialization.

impl Copy for FakeReadCause

impl StructuralPartialEq for FakeReadCause

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

Size for each variant:

• ForMatchGuard: 0 bytes
• ForMatchedPlace: 4 bytes
• ForGuardBinding: 0 bytes
• ForLet: 4 bytes
• ForIndex: 0 bytes