Struct alloc_wg::alloc::MemoryBlock

#[must_use = "`MemoryBlock` should be passed to `AllocRef::dealloc`"]pub struct MemoryBlock { /* fields omitted */ }

Represents a block of allocated memory returned by an allocator.

Methods

impl MemoryBlock

pub const unsafe fn new(ptr: NonNull<u8>, layout: Layout) -> Self

Creates a new MemoryBlock.

Safety

• The block must be allocated with the same alignment as [layout.align()], and
• The provided [layout.size()] must fall in the range min ..= max, where:
  • min is the size requested size when allocating the block, and
  • max is the size of the memory block.

pub const fn ptr(&self) -> NonNull<u8>

Acquires the underlying NonNull<u8> pointer.

pub const fn layout(&self) -> Layout

Returns the layout describing the memory block.

pub const fn size(&self) -> usize

Returns the size of the memory block.

pub const fn align(&self) -> usize

Returns the minimum alignment of the memory block.

pub fn init(&mut self, init: AllocInit)

Initialize the memory block like specified by init.

This behaves like calling MemoryBlock::initialize_offset(ptr, layout, 0).

pub unsafe fn init_offset(&mut self, init: AllocInit, offset: usize)

Initialize the memory block like specified by init at the specified offset.

This is a no-op for AllocInit::Uninitialized and writes zeroes for AllocInit::Zeroed at ptr + offset until ptr + layout.size().

Safety

• offset must be smaller than or equal to size()

Trait Implementations

impl Debug for MemoryBlock

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

Formats the value using the given formatter.