PointsTo

vstd::simple_pptr

Struct PointsTo 

Source 
pub struct PointsTo<V> { /* private fields */ }
Expand description

A tracked ghost object that gives the user permission to dereference a pointer for reading or writing, or to free the memory at that pointer.

The meaning of a PointsTo object is given by the data in its View object, PointsToData.

See the PPtr documentation for more details.

Implementations§

Source§

impl<V> PointsTo<V>

Source

pub open spec fn pptr(&self) -> PPtr<V>

{ PPtr(self.addr(), PhantomData) }
Source

pub closed spec fn addr(self) -> usize

Source

pub closed spec fn mem_contents(&self) -> MemContents<V>

Source

pub open spec fn is_init(&self) -> bool

{ self.mem_contents().is_init() }
Source

pub open spec fn is_uninit(&self) -> bool

{ self.mem_contents().is_uninit() }
Source

pub open spec fn value(&self) -> V

recommends
self.is_init(),
{ self.mem_contents().value() }
Source

pub proof fn is_nonnull(tracked &self)

ensures
self.addr() != 0,

Guarantee that the PointsTo points to a non-null address.

Source

pub proof fn leak_contents(tracked &mut self)

ensures
self.pptr() == old(self).pptr(),
self.is_uninit(),

“Forgets” about the value stored behind the pointer. Updates the PointsTo value to MemContents::Uninit. Note that this is a proof function, i.e., it is operationally a no-op in executable code.

Source

pub proof fn is_disjoint<S>(tracked &mut self, tracked other: &PointsTo<S>)

ensures
*old(self) == *self,
self.addr() + size_of::<V>() <= other.addr()
    || other.addr() + size_of::<S>() <= self.addr(),

Guarantees that two distinct PointsTo<V> objects point to disjoint ranges of memory. If both S and V are non-zero-sized, then this also implies the pointers have distinct addresses.

Source

pub proof fn is_distinct<S>(tracked &mut self, tracked other: &PointsTo<S>)

requires
size_of::<V>() != 0,
size_of::<S>() != 0,
ensures
*old(self) == *self,
self.addr() != other.addr(),

Guarantees that two distinct, non-ZST PointsTo<V> objects point to different addresses. This is a corollary of PointsTo::is_disjoint.

Auto Trait Implementations§

§

impl<V> Freeze for PointsTo<V>

§

impl<V> RefUnwindSafe for PointsTo<V>
where V: RefUnwindSafe,

§

impl<V> Send for PointsTo<V>
where V: Send,

§

impl<V> Sync for PointsTo<V>
where V: Sync,

§

impl<V> Unpin for PointsTo<V>
where V: Unpin,

§

impl<V> UnwindSafe for PointsTo<V>
where V: UnwindSafe,

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, VERUS_SPEC__A> FromSpec<T> for VERUS_SPEC__A
where VERUS_SPEC__A: From<T>,

Source§

exec fn obeys_from_spec() -> bool

Source§

exec fn from_spec(v: T) -> VERUS_SPEC__A

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, VERUS_SPEC__A> IntoSpec<T> for VERUS_SPEC__A
where VERUS_SPEC__A: Into<T>,

Source§

exec fn obeys_into_spec() -> bool

Source§

exec fn into_spec(self) -> T

Source§

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

Source§

open spec fn obeys_into_spec() -> bool

{ <U as FromSpec<Self>>::obeys_from_spec() }
Source§

open spec fn into_spec(self) -> U

{ U::from_spec(self) }
Source§

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

Source§

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, VERUS_SPEC__A> TryFromSpec<T> for VERUS_SPEC__A
where VERUS_SPEC__A: TryFrom<T>,

Source§

exec fn obeys_try_from_spec() -> bool

Source§

exec fn try_from_spec( v: T, ) -> Result<VERUS_SPEC__A, <VERUS_SPEC__A as TryFrom<T>>::Error>

Source§

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

Source§

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

impl<T, VERUS_SPEC__A> TryIntoSpec<T> for VERUS_SPEC__A
where VERUS_SPEC__A: TryInto<T>,

Source§

exec fn obeys_try_into_spec() -> bool

Source§

exec fn try_into_spec(self) -> Result<T, <VERUS_SPEC__A as TryInto<T>>::Error>

Source§

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

Source§

open spec fn obeys_try_into_spec() -> bool

{ <U as TryFromSpec<Self>>::obeys_try_from_spec() }
Source§

open spec fn try_into_spec(self) -> Result<U, <U as TryFrom<T>>::Error>

{ <U as TryFromSpec<Self>>::try_from_spec(self) }