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

source ·
pub struct PermTransition {
    from: PermissionPriv,
    to: PermissionPriv,
}
Expand description

Transition from one permission to the next.

Fields§

§from: PermissionPriv§to: PermissionPriv

Implementations§

source§

impl PermTransition

source

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

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

source

pub(in borrow_tracker::tree_borrows) fn is_relevant( &self, err: TransitionError, ) -> bool

Determines whether self is a relevant transition for the error err. self will be a transition that happened to a tag some time before that tag caused the error.

Irrelevant events:

  • modifications of write permissions when the error is related to read permissions (on failed reads and protected Frozen -> Disabled, ignore Reserved -> Active, Reserved(conflicted=false) -> Reserved(conflicted=true), and Active -> Frozen)
  • all transitions for attempts to deallocate strongly protected tags
§Panics

This function assumes that its arguments apply to the same location and that they were obtained during a normal execution. It will panic otherwise.

  • all transitions involved in self and err should be increasing (Reserved < Active < Frozen < Disabled);
  • between self and err the permission should also be increasing, so all permissions inside err should be greater than self.1;
  • Active and Reserved(conflicted=false) cannot cause an error due to insufficient permissions, so err cannot be a ChildAccessForbidden(_) of either of them;
  • err should not be ProtectedDisabled(Disabled), because the protected tag should not have been Disabled in the first place (if this occurs it means we have unprotected tags that become protected)
source

pub fn endpoint(&self) -> Permission

Endpoint of a transition. Meant only for diagnostics, use applied in non-diagnostics code, which also checks that the starting point matches the current state.

source§

impl PermTransition

source

fn is_possible(self) -> 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.

source

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

source

pub fn is_noop(self) -> bool

source

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

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

source

pub fn started(self) -> Permission

Extract starting point of a transition

source

pub fn produces_disabled(self) -> bool

Determines if this transition would disable the permission.

Trait Implementations§

source§

impl Clone for PermTransition

source§

fn clone(&self) -> PermTransition

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for PermTransition

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for PermTransition

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for PermTransition

source§

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

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

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.
source§

impl Copy for PermTransition

source§

impl Eq for PermTransition

source§

impl StructuralPartialEq for PermTransition

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

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