Struct corundum::ptr::Ptr

pub struct Ptr<T: ?Sized, A: MemPool> { /* private fields */ }

A wrapper around a raw persistent pointer that indicates that the possessor of this wrapper owns the referent. Useful for building abstractions like Pbox<T,P>, Vec<T,P>, and String<P>.

Just like raw pointers, it contains the address of the object, but the address is static within a file.

Note that, memory pools are types, not objects. For more information, please see MemPool.

Implementations

impl<A: MemPool, T: ?Sized> Ptr<T, A>

pub fn is_dangling(&self) -> bool

Checks if this pointer is dangling

pub fn off(&self) -> u64

Returns the file offset

pub fn off_ref(&self) -> &u64

Returns a reference to the file offset

impl<A: MemPool, T: ?Sized> Ptr<T, A>

pub unsafe fn from_raw(other: *const T) -> Self

Trait Implementations

impl<A: MemPool, T: PSafe + ?Sized> Clone for Ptr<T, A>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: MemPool, T: Debug + PSafe + ?Sized> Debug for Ptr<T, A>

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

Formats the value using the given formatter.

impl<A: MemPool, T: PSafe + ?Sized> Deref for Ptr<T, A>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<A: MemPool, T: PSafe + ?Sized> DerefMut for Ptr<T, A>

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

Mutably dereferences the value.

impl<A: MemPool, T: Display + PSafe + ?Sized> Display for Ptr<T, A>

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

Formats the value using the given formatter.

impl<A: MemPool, T: ?Sized> PartialEq<Ptr<T, A>> for Ptr<T, A>

fn eq(&self, other: &Self) -> 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 !=.

impl<A: MemPool, T: PSafe> PmemUsage for Ptr<T, A>

fn size_of() -> usize

Size of the object on Persistent Memory Assuming that self is not on PM, or considered else were, the size of allocated persistent memory is the sum of all persistent objects pointed by this object.

fn size_of_pmem() -> usize

Size of the object on Persistent Memory including Self Assuming that self is also on PM (e.g. the root object), the size of allocated persistent memory includes the size of all objects pointed by this object and the size Self.

impl<A: MemPool, T: PSafe + ?Sized> Copy for Ptr<T, A>

impl<T: Eq + ?Sized, A: Eq + MemPool> Eq for Ptr<T, A>

impl<A: MemPool, T: PSafe + ?Sized> PSafe for Ptr<T, A>

The allocator does not need to implement PSafe

impl<A: MemPool, T: PSafe> PSafe for Ptr<[T], A>

impl<A: MemPool, T> !Send for Ptr<T, A>

Ptr pointers are not Send because the data they reference may be aliased.

impl<T: ?Sized, A: MemPool> StructuralEq for Ptr<T, A>

impl<A: MemPool, T> !Sync for Ptr<T, A>

Ptr pointers are not Sync because the data they reference may be aliased.

impl<A: MemPool, T> !TxOutSafe for Ptr<T, A>