Struct ZeroAwareAllocator 

pub struct ZeroAwareAllocator<A, L>
where
    A: Allocator,
    L: LockingMechanism,
{ /* private fields */ }

A memory allocator that keeps track of already-zeroed memory blocks.

This lets applications move zeroing off of the allocate_zeroed critical path. Instead they can, for example, bulk-zero memory blocks in the background before returning them to the allocator.

This allocator wraps an underinglying, inner allocator of type A, layering the bookkeeping of already-zeroed blocks on top of it.

Because this crate is no_std and does not assume the presence of an operating system, you must provide your own locking mechanism via the L type parameter. See the LockingMechanism trait for details.

Implementations

impl<A, L> ZeroAwareAllocator<A, L>

where A: Allocator, L: LockingMechanism,

pub const fn new(inner: A, lock: L) -> Self

Create a new ZeroAwareAllocator that wraps the given inner allocator.

pub fn inner(&self) -> &A

Get a shared reference to the inner allocator.

pub fn inner_mut(&mut self) -> &mut A

Get an exclusive reference to the inner allocator.

pub fn return_zeroed_memory_to_inner(&mut self)

Return all of the known-zeroed memory blocks to the underlying allocator.

Trait Implementations

impl<A, L> Allocator for ZeroAwareAllocator<A, L>

where A: Allocator, L: LockingMechanism,

fn allocate(&self, layout: Layout) -> Result<NonNull<[u8]>, AllocError>

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

Attempts to allocate a block of memory.

unsafe fn deallocate(&self, ptr: NonNull<u8>, user_layout: Layout)

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

Deallocates the memory referenced by ptr.

fn allocate_zeroed(&self, layout: Layout) -> Result<NonNull<[u8]>, AllocError>

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

Behaves like allocate, but also ensures that the returned memory is zero-initialized.

unsafe fn grow( &self, ptr: NonNull<u8>, user_old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

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

Attempts to extend the memory block.

unsafe fn grow_zeroed( &self, ptr: NonNull<u8>, user_old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

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

Behaves like grow, but also ensures that the new contents are set to zero before being returned.

unsafe fn shrink( &self, ptr: NonNull<u8>, old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

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

Attempts to shrink the memory block.

fn by_ref(&self) -> &Self

where Self: Sized,

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

Creates a “by reference” adapter for this instance of Allocator.

impl<A, L> DeallocateZeroed for ZeroAwareAllocator<A, L>

where A: Allocator, L: LockingMechanism,

unsafe fn deallocate_zeroed(&self, ptr: NonNull<u8>, layout: Layout)

Deallocate already-zeroed memory.

impl<A, L> Default for ZeroAwareAllocator<A, L>

where A: Allocator + Default, L: LockingMechanism + Default,

fn default() -> ZeroAwareAllocator<A, L>

Returns the “default value” for a type.

impl<A, L> Drop for ZeroAwareAllocator<A, L>

where A: Allocator, L: LockingMechanism,

fn drop(&mut self)

Executes the destructor for this type.