Struct miri::borrow_tracker::tree_borrows::perms::PermTransition

pub struct PermTransition(PermissionPriv, PermissionPriv);

Transition from one permission to the next.

Tuple Fields

0: PermissionPriv

1: PermissionPriv

Implementations

impl PermTransition

pub fn summary(&self) -> &'static str

Readable explanation of the consequences of an event. Fits in the sentence “This accessed caused {trans.summary()}”.

Important: for the purposes of this explanation, Reserved is considered to have write permissions, because that’s what the diagnostics care about (otherwise Reserved -> Frozen would be considered a noop).

impl PermTransition

fn is_possible(old: PermissionPriv, new: PermissionPriv) -> bool

All transitions created through normal means (using perform_access) should be possible, but the same is not guaranteed by construction of transitions inferred by diagnostics. This checks that a transition reconstructed by diagnostics is indeed one that could happen.

pub fn from(old: Permission, new: Permission) -> Option<Self>

pub fn is_noop(self) -> bool

pub fn applied(self, starting_point: Permission) -> Option<Permission>

Extract result of a transition (checks that the starting point matches).

pub fn started(self) -> Permission

Extract starting point of a transition

pub fn is_allowed_by_protector(&self) -> bool

Determines whether a transition that occured is compatible with the presence of a Protector. This is not included in the transition functions because it would distract from the few places where the transition is modified because of a protector, but not forbidden.

Note: this is not in charge of checking that there is a protector, it should be used as

let no_protector_error = if is_protected(tag) {
    transition.is_allowed_by_protector()
};

pub fn apply_start(self, app: Self) -> Option<Self>

Composition function: get the transition that can be added after app to produce self.

Trait Implementations

impl Clone for PermTransition

fn clone(&self) -> PermTransition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PermTransition

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

Formats the value using the given formatter.

impl Display for PermTransition

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

Formats the value using the given formatter.

impl PartialEq<PermTransition> for PermTransition

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

impl Eq for PermTransition

impl StructuralEq for PermTransition

impl StructuralPartialEq for PermTransition

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