Enum sp_std::alloc::AllocInit

pub enum AllocInit {
    Uninitialized,
    Zeroed,
}

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

A desired initial state for allocated memory.

Variants

Uninitialized

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

The contents of the new memory are uninitialized.

Zeroed

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

The new memory is guaranteed to be zeroed.

Implementations

impl AllocInit

pub unsafe fn init(self, memory: MemoryBlock)

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

Initialize the specified memory block.

This behaves like calling AllocInit::init_offset(memory, 0).

Safety

• memory.ptr must be valid for writes of memory.size bytes.

pub unsafe fn init_offset(self, memory: MemoryBlock, offset: usize)

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

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

• memory.ptr must be valid for writes of memory.size bytes.
• offset must be smaller than or equal to memory.size

Trait Implementations

impl Clone for AllocInit

fn clone(&self) -> AllocInit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for AllocInit

impl Debug for AllocInit

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

Formats the value using the given formatter.

impl Eq for AllocInit

impl PartialEq<AllocInit> for AllocInit

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

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

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

This method tests for !=.