Enum BorrowKind

pub enum BorrowKind {
    Shared,
    Mut,
    TwoPhaseMut,
    Shallow,
    UniqueImmutable,
}

Variants

Shared

Mut

TwoPhaseMut

See https://doc.rust-lang.org/beta/nightly-rustc/rustc_middle/mir/enum.MutBorrowKind.html#variant.TwoPhaseBorrow and https://rustc-dev-guide.rust-lang.org/borrow_check/two_phase_borrows.html

Shallow

Those are typically introduced when using guards in matches, to make sure guards don’t change the variant of an enum value while me match over it.

See https://doc.rust-lang.org/beta/nightly-rustc/rustc_middle/mir/enum.FakeBorrowKind.html#variant.Shallow.

UniqueImmutable

Data must be immutable but not aliasable. In other words you can’t mutate the data but you can mutate through it, e.g. if it points to a &mut T. This is only used in closure captures, e.g.

let mut z = 3;
let x: &mut isize = &mut z;
let y = || *x += 5;

Here the captured variable can’t be &mut &mut x since the x binding is not mutable, yet we must be able to mutate what it points to.

See https://doc.rust-lang.org/beta/nightly-rustc/rustc_middle/mir/enum.MutBorrowKind.html#variant.ClosureCapture.

Implementations

impl BorrowKind

pub fn is_shared(&self) -> bool

pub fn is_mut(&self) -> bool

pub fn is_two_phase_mut(&self) -> bool

pub fn is_shallow(&self) -> bool

pub fn is_unique_immutable(&self) -> bool

impl BorrowKind

pub fn as_shared(&self) -> Option<()>

pub fn as_mut(&self) -> Option<()>

pub fn as_two_phase_mut(&self) -> Option<()>

pub fn as_shallow(&self) -> Option<()>

pub fn as_unique_immutable(&self) -> Option<()>

impl BorrowKind

pub fn as_shared_mut(&mut self) -> Option<()>

pub fn as_mut_mut(&mut self) -> Option<()>

pub fn as_two_phase_mut_mut(&mut self) -> Option<()>

pub fn as_shallow_mut(&mut self) -> Option<()>

pub fn as_unique_immutable_mut(&mut self) -> Option<()>

impl BorrowKind

pub fn mutable(x: bool) -> Self

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<'de> Deserialize<'de> for BorrowKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BorrowKind

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

Formats the value using the given formatter.

impl Drive for BorrowKind

fn drive<V: Visitor>(&self, visitor: &mut V)

impl DriveMut for BorrowKind

fn drive_mut<V: VisitorMut>(&mut self, visitor: &mut V)

impl PartialEq for BorrowKind

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for BorrowKind

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for BorrowKind

impl Eq for BorrowKind

impl StructuralPartialEq for BorrowKind