Struct secmem_alloc::zeroizing_alloc::ZeroizeAlloc

pub struct ZeroizeAlloc<BackendAlloc, Z: MemZeroizer = DefaultMemZeroizer> { /* fields omitted */ }

Wrapper around an allocator which zeroizes memory on deallocation. See the module level documentation.

If debug assertions are enabled, some of the safety requirement for using an allocator are checked.

Implementations

impl<A> ZeroizeAlloc<A>

pub const fn new(backend_alloc: A) -> Self

Create a zeroizing allocator using backend_alloc for allocations and zeroizer to zeroize memory upon deallocation.

impl<A, Z: MemZeroizer> ZeroizeAlloc<A, Z>

pub fn with_zeroizer(backend_alloc: A, zeroizer: Z) -> Self

Create a zeroizing allocator using backend_alloc for allocations and zeroizer to zeroize memory upon deallocation.

impl<A, Z: MemZeroizer + Default> ZeroizeAlloc<A, Z>

pub fn with_default_zeroizer(backend_alloc: A) -> Self

Create a zeroizing allocator using backend_alloc for allocations and zeroizer to zeroize memory upon deallocation.

Trait Implementations

impl<B, Z> Allocator for ZeroizeAlloc<B, Z> where
    B: Allocator,
    Z: MemZeroizer, 

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.

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 deallocate(&self, ptr: NonNull<u8>, layout: Layout)

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

Deallocates the memory referenced by ptr.

unsafe fn grow(
    &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 extend the memory block.

unsafe fn grow_zeroed(
    &self,
    ptr: NonNull<u8>,
    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

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

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

impl<BackendAlloc: Debug, Z: Debug + MemZeroizer> Debug for ZeroizeAlloc<BackendAlloc, Z>

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

Formats the value using the given formatter.

impl<BackendAlloc: Default, Z: Default + MemZeroizer> Default for ZeroizeAlloc<BackendAlloc, Z>

fn default() -> ZeroizeAlloc<BackendAlloc, Z>

Returns the “default value” for a type.

impl<B, Z> GlobalAlloc for ZeroizeAlloc<B, Z> where
    B: GlobalAlloc,
    Z: MemZeroizer, 

unsafe fn alloc(&self, layout: Layout) -> *mut u8

Allocate memory as described by the given layout.

unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout)

Deallocate the block of memory at the given ptr pointer with the given layout.

unsafe fn alloc_zeroed(&self, layout: Layout) -> *mut u8

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

unsafe fn realloc(
    &self,
    ptr: *mut u8,
    layout: Layout,
    new_size: usize
) -> *mut u8

Shrink or grow a block of memory to the given new_size. The block is described by the given ptr pointer and layout.