Enum rustc_middle::mir::BorrowKind

pub enum BorrowKind {
    Shared,
    Shallow,
    Mut {
        kind: MutBorrowKind,
    },
}

Variants

Shared

Data must be immutable and is aliasable.

Shallow

The immediately borrowed place must be immutable, but projections from it don’t need to be. For example, a shallow borrow of a.b doesn’t conflict with a mutable borrow of a.b.c.

This is used when lowering matches: when matching on a place we want to ensure that place have the same value from the start of the match until an arm is selected. This prevents this code from compiling:

let mut x = &Some(0);
match *x {
    None => (),
    Some(_) if { x = &None; false } => (),
    Some(_) => (),
}

This can’t be a shared borrow because mutably borrowing (*x as Some).0 should not prevent if let None = x { ... }, for example, because the mutating (*x as Some).0 can’t affect the discriminant of x. We can also report errors with this kind of borrow differently.

Mut

Fields

kind: MutBorrowKind

Data is mutable and not aliasable.

Implementations

impl BorrowKind

pub fn mutability(&self) -> Mutability

pub fn allows_two_phase_borrow(&self) -> bool

impl BorrowKind

pub fn to_mutbl_lossy(self) -> Mutability

Trait Implementations

impl Clone for BorrowKind

fn clone(&self) -> BorrowKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BorrowKind

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

Formats the value using the given formatter.

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

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

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

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

impl Hash for BorrowKind

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

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

impl Ord for BorrowKind

fn cmp(&self, other: &BorrowKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<BorrowKind> for BorrowKind

fn eq(&self, other: &BorrowKind) -> 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 PartialOrd<BorrowKind> for BorrowKind

fn partial_cmp(&self, other: &BorrowKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for BorrowKind

fn try_fold_with<F: FallibleTypeFolder<TyCtxt<'tcx>>>( self, _: &mut F ) -> Result<Self, 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<TyCtxt<'tcx>>>(self, _: &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<TyCtxt<'tcx>> for BorrowKind

fn visit_with<F: TypeVisitor<TyCtxt<'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).

impl Copy for BorrowKind

impl Eq for BorrowKind

impl StructuralEq for BorrowKind

impl StructuralPartialEq for BorrowKind

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: 1 byte

Size for each variant:

• Shared: 0 bytes
• Shallow: 0 bytes
• Mut: 1 byte