Struct vstd::simple_pptr::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>(&mut self, 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>(&mut self, 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> 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, 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, 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.