Struct BrandedBlock 

pub struct BrandedBlock<'brand, T>
where
    T: ?Sized,
{ /* private fields */ }

A wrapper representing a heap block branded with a compile-time unique lifetime.

Implementations

impl<'brand, T> BrandedBlock<'brand, T>

where T: ?Sized,

pub fn as_ptr(&self) -> *mut T

Returns the raw pointer to the block’s managed memory.

impl<'brand, T> BrandedBlock<'brand, T>

pub unsafe fn cast<U>(self) -> BrandedBlock<'brand, U>

Casts this branded block to managed memory of a different type, preserving the brand.

Safety

The returned BrandedBlock<'brand, U> is trusted by safe APIs that interpret the pointee as a U: crate::Heap::free runs core::ptr::drop_in_place::<U> on it and derives its deallocation path from size_of_val of the U, crate::Heap::realloc reads the pointee’s layout the same way, and super::BrandedCell::from_block hands out &U/&mut U. The caller must therefore guarantee:

• Layout: the block’s allocation is at least size_of::<U>() bytes and aligned to align_of::<U>() (e.g. it was allocated for a layout that covers U), and
• Initialization/drop discipline: either the memory holds a valid U before any path reads or drops it as one, or the block is treated as uninitialized U storage — written with a valid U before such a path (as crate::Heap::alloc_init does), or released exclusively through the non-dropping crate::Heap::free_uninit.

Violating either (for example casting an initialized usize block to String and freeing it) is a transmute-and-drop and undefined behavior.

Trait Implementations

impl<'brand, T> Debug for BrandedBlock<'brand, T>

where T: ?Sized,

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

Formats the value using the given formatter.

impl<'brand, T> Eq for BrandedBlock<'brand, T>

where T: ?Sized,

impl<'brand, T> Hash for BrandedBlock<'brand, T>

where T: ?Sized,

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, T> Ord for BrandedBlock<'brand, T>

where T: ?Sized,

fn cmp(&self, other: &BrandedBlock<'brand, 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.

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, T> PartialEq for BrandedBlock<'brand, T>

where T: ?Sized,

fn eq(&self, other: &BrandedBlock<'brand, T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'brand, T> PartialOrd for BrandedBlock<'brand, T>

where T: ?Sized,

fn partial_cmp(&self, other: &BrandedBlock<'brand, 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<'brand, T> Pointer for BrandedBlock<'brand, T>

where T: ?Sized,

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

Formats the value using the given formatter.