Struct Allocation

pub struct Allocation<'a, T = u8> {
    pub ptr: NonNull<T>,
    pub lifetime: AllocTime<'a>,
    pub level: Level,
}

A successful allocation and current Level.

Fields

ptr: NonNull<T>

Pointer to the uninitialized region with specified layout.

lifetime: AllocTime<'a>

The lifetime of the allocation.

level: Level

The observed amount of consumed bytes after the allocation.

Implementations

impl<'alloc, T> Allocation<'alloc, T>

pub unsafe fn leak(self, val: T) -> &'alloc mut T

Write a value into the allocation and leak it.

Safety

Must have been allocated for a layout that fits the layout of T previously. The pointer must not be aliased.

Usage

Consider the alternative Bump::leak to safely allocate and directly leak a value.

pub unsafe fn boxed(self, val: T) -> LeakBox<'alloc, T>

Write a value into the allocation and own it.

Safety

Must have been allocated for a layout that fits the layout of T previously. The pointer must not be aliased.

Usage

Consider the alternative Bump::leak to safely allocate and directly leak a value.

pub unsafe fn uninit(self) -> &'alloc mut MaybeUninit<T>

Convert this into a mutable reference to an uninitialized slot.

Safety

Must have been allocated for a layout that fits the layout of T previously.

Trait Implementations

impl<'a, T: Clone> Clone for Allocation<'a, T>

fn clone(&self) -> Allocation<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for Allocation<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: Ord> Ord for Allocation<'a, T>

fn cmp(&self, other: &Allocation<'a, T>) -> 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.

impl<'a, T: PartialEq> PartialEq for Allocation<'a, T>

fn eq(&self, other: &Allocation<'a, T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T: PartialOrd> PartialOrd for Allocation<'a, T>

fn partial_cmp(&self, other: &Allocation<'a, T>) -> 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<'a, T: Copy> Copy for Allocation<'a, T>

impl<'a, T: Eq> Eq for Allocation<'a, T>

impl<'a, T> StructuralPartialEq for Allocation<'a, T>