Struct BrandedBox 

pub struct BrandedBox<'brand, 'heap, T, P = StandardPolicy, B = MemoryBackendWrapper>
where
    P: AllocPolicy,
    B: HasSegmentPool + LocalAllocatorSelector<B>,
    T: ?Sized,
{ /* private fields */ }

A uniquely owned, safe pointer to heap-allocated memory of type T from a Heap.

Automatically drops T and deallocates the memory back to the heap on drop.

Implementations

impl<'brand, 'heap, T, P, B> BrandedBox<'brand, 'heap, T, P, B>

where P: AllocPolicy, B: HasSegmentPool + LocalAllocatorSelector<B>,

pub fn new<Permit>( heap: &'heap Heap<'brand, P, B>, permit: Permit, val: T, ) -> Option<BrandedBox<'brand, 'heap, T, P, B>>

where Permit: ReadPermit<'brand>,

Creates a new BrandedBox containing val allocated from the given Heap.

impl<'brand, 'heap, T, P, B> BrandedBox<'brand, 'heap, T, P, B>

where P: AllocPolicy, B: HasSegmentPool + LocalAllocatorSelector<B>, T: ?Sized,

pub fn into_raw(self) -> BrandedBlock<'brand, T>

Consumes the BrandedBox, returning the wrapped raw block without dropping or deallocating.

pub fn into_cell(self) -> BrandedCell<'brand, T>

Converts this BrandedBox into a shared BrandedCell.

The memory remains allocated until it is manually reclaimed.

pub unsafe fn from_cell( heap: &'heap Heap<'brand, P, B>, cell: BrandedCell<'brand, T>, ) -> BrandedBox<'brand, 'heap, T, P, B>

Reconstructs a BrandedBox from a shared BrandedCell.

Safety

The caller must ensure that no other copies of this BrandedCell (or pointers derived from it) are active or will be used.

pub unsafe fn from_raw( heap: &'heap Heap<'brand, P, B>, block: BrandedBlock<'brand, T>, ) -> BrandedBox<'brand, 'heap, T, P, B>

Reconstructs a BrandedBox from a raw block.

Safety

The memory block must be initialized with a valid value of type T.

impl<'brand, 'heap, T, P, B> BrandedBox<'brand, 'heap, T, P, B>

where T: Clone, P: AllocPolicy, B: HasSegmentPool + LocalAllocatorSelector<B>,

pub fn clone_in<Permit>( &self, permit: &Permit, ) -> Option<BrandedBox<'brand, 'heap, T, P, B>>

where &'token Permit: for<'token> ReadPermit<'brand>,

Clones the box using the given allocator read permit.

Returns None if allocation fails.

Trait Implementations

impl<'brand, 'heap, T, P, B> Debug for BrandedBox<'brand, 'heap, T, P, B>

where T: Debug + ?Sized, P: AllocPolicy, B: HasSegmentPool + LocalAllocatorSelector<B>,

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

Formats the value using the given formatter.

impl<'brand, 'heap, T, P, B> Deref for BrandedBox<'brand, 'heap, T, P, B>

where P: AllocPolicy, B: HasSegmentPool + LocalAllocatorSelector<B>, T: ?Sized,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<BrandedBox<'brand, 'heap, T, P, B> as Deref>::Target

Dereferences the value.

impl<'brand, 'heap, T, P, B> DerefMut for BrandedBox<'brand, 'heap, T, P, B>

where P: AllocPolicy, B: HasSegmentPool + LocalAllocatorSelector<B>, T: ?Sized,

fn deref_mut( &mut self, ) -> &mut <BrandedBox<'brand, 'heap, T, P, B> as Deref>::Target

Mutably dereferences the value.

impl<'brand, 'heap, T, P, B> Display for BrandedBox<'brand, 'heap, T, P, B>

where T: Display + ?Sized, P: AllocPolicy, B: HasSegmentPool + LocalAllocatorSelector<B>,

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

Formats the value using the given formatter.

impl<'brand, 'heap, T, P, B> Drop for BrandedBox<'brand, 'heap, T, P, B>

where P: AllocPolicy, B: HasSegmentPool + LocalAllocatorSelector<B>, T: ?Sized,

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<'brand, 'heap, T, P, B> Eq for BrandedBox<'brand, 'heap, T, P, B>

where T: Eq + ?Sized, P: AllocPolicy, B: HasSegmentPool + LocalAllocatorSelector<B>,

impl<'brand, 'heap, T, P, B> Hash for BrandedBox<'brand, 'heap, T, P, B>

where T: Hash + ?Sized, P: AllocPolicy, B: HasSegmentPool + LocalAllocatorSelector<B>,

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'brand, 'heap, T, P, B> Ord for BrandedBox<'brand, 'heap, T, P, B>

where T: Ord + ?Sized, P: AllocPolicy, B: HasSegmentPool + LocalAllocatorSelector<B>,

fn cmp(&self, other: &BrandedBox<'brand, 'heap, T, P, B>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl<'brand, 'heap, T, P, B> PartialEq for BrandedBox<'brand, 'heap, T, P, B>

where T: PartialEq + ?Sized, P: AllocPolicy, B: HasSegmentPool + LocalAllocatorSelector<B>,

fn eq(&self, other: &BrandedBox<'brand, 'heap, T, P, B>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'brand, 'heap, T, P, B> PartialOrd for BrandedBox<'brand, 'heap, T, P, B>

where T: PartialOrd + ?Sized, P: AllocPolicy, B: HasSegmentPool + LocalAllocatorSelector<B>,

fn partial_cmp( &self, other: &BrandedBox<'brand, 'heap, T, P, B>, ) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'brand, 'heap, T, P, B> Pointer for BrandedBox<'brand, 'heap, T, P, B>

where P: AllocPolicy, B: HasSegmentPool + LocalAllocatorSelector<B>, T: ?Sized,

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

Formats the value using the given formatter.