Struct crndm::ptr::FatPtr

pub struct FatPtr<T: PSafe, A: MemPool> { /* fields omitted */ }

A persistent fat pointer with offset and capacity

Implementations

impl<T: PSafe, A: MemPool> FatPtr<T, A>

pub unsafe fn new(x: &[T]) -> Self

Creates a new fat pointer given a slice

pub fn empty() -> Self

Sets the capacity to zero

pub fn is_empty(&self) -> bool

Returns true if the capacity is zero

pub fn get(&self, i: usize) -> &T

Returns a reference to the object at index i

pub fn get_mut(&self, i: usize) -> &mut T

Returns a mutable reference to the object at index i

pub unsafe fn get_unchecked(&self, i: usize) -> &mut T

Returns a mutable reference to the object at index i without checking the boundaries

pub fn off(&self) -> u64

Returns the offset

pub fn capacity(&self) -> usize

Returns the capacity of the fat pointer

pub unsafe fn as_slice(&self) -> &[T]

Converts the fat pointer into a slice of type &[T]

pub unsafe fn split_at(&mut self, mid: usize) -> (&[T], &[T])

Divides one slice into two at an index.

The first will contain all indices from [0, mid) (excluding the index mid itself) and the second will contain all indices from [mid, len) (excluding the index len itself).

Panics

Panics if mid > len.

pub unsafe fn split_at_mut(&mut self, mid: usize) -> (&mut [T], &mut [T])

Divides one mutable slice into two at an index.

The first will contain all indices from [0, mid) (excluding the index mid itself) and the second will contain all indices from [mid, len) (excluding the index len itself).

Panics

Panics if mid > len.

pub unsafe fn dup(&self, len: usize) -> FatPtr<T, A>

Creates a new copy of data and returns a FatPtr pointer

Safety

The compiler would not drop the copied data. Developer has the responsibility of deallocating inner value. Also, it does not clone the inner value. Instead, it just copies the memory.

Trait Implementations

impl<A: MemPool, T: PSafe> Clone for FatPtr<T, A>

pub fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: MemPool + Copy, T: PSafe + Copy> Copy for FatPtr<T, A>

impl<A: MemPool, T: PSafe> Default for FatPtr<T, A>

pub fn default() -> Self

Returns the "default value" for a type.

impl<T: Eq + PSafe, A: Eq + MemPool> Eq for FatPtr<T, A>

impl<A: MemPool, T: PSafe, '_> From<&'_ [T]> for FatPtr<T, A>

pub fn from(other: &[T]) -> Self

Performs the conversion.

impl<A: MemPool, T: PSafe, '_> From<&'_ mut [T]> for FatPtr<T, A>

pub fn from(other: &mut [T]) -> Self

Performs the conversion.

impl<T: PSafe, A: MemPool> Index<usize> for FatPtr<T, A>

type Output = T

The returned type after indexing.

pub fn index(&self, i: usize) -> &T

Performs the indexing (container[index]) operation.

impl<T: PSafe, A: MemPool> PSafe for FatPtr<T, A>

impl<A: MemPool, T: PSafe> PartialEq<FatPtr<T, A>> for FatPtr<T, A>

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

pub 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.

pub 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> !Send for FatPtr<T, A>

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

impl<T: PSafe, A: MemPool> StructuralEq for FatPtr<T, A>

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

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

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