Struct allocator_suite::adaptors::allocator_adaptor::AllocatorAdaptor

#[repr(transparent)]
pub struct AllocatorAdaptor<'a, A: 'a + Allocator>(_);

Adapts an Allocator to the GlobalAlloc and Alloc traits.

Trait Implementations

impl<'a, A: 'a + Allocator> Allocator for AllocatorAdaptor<'a, A>

fn allocate(
    &self,
    non_zero_size: NonZeroUsize,
    non_zero_power_of_two_alignment: NonZeroUsize
) -> Result<MemoryAddress, AllocErr>

Allocate memory.

fn deallocate(
    &self,
    non_zero_size: NonZeroUsize,
    non_zero_power_of_two_alignment: NonZeroUsize,
    current_memory: MemoryAddress
)

Deallocate (free) memory.

fn growing_reallocate(
    &self,
    non_zero_new_size: NonZeroUsize,
    non_zero_power_of_two_alignment: NonZeroUsize,
    non_zero_current_size: NonZeroUsize,
    current_memory: MemoryAddress
) -> Result<MemoryAddress, AllocErr>

Reallocate memory by growing it.

fn shrinking_reallocate(
    &self,
    non_zero_new_size: NonZeroUsize,
    non_zero_power_of_two_alignment: NonZeroUsize,
    non_zero_current_size: NonZeroUsize,
    current_memory: MemoryAddress
) -> Result<MemoryAddress, AllocErr>

Reallocate memory by shrinking it.

const ZERO_SIZED_ALLOCATION: MemoryAddress

The sentinel value used for a zero-sized allocation.

fn adapt<'a>(&'a self) -> AllocatorAdaptor<'a, Self>

Adapts to a GlobalAlloc and Alloc.

fn adapt_reference<'a>(&'a self) -> &'a AllocatorAdaptor<'a, Self>

Adapts a reference to a GlobalAlloc and Alloc reference.

impl<'a, A: Debug + 'a + Allocator> Debug for AllocatorAdaptor<'a, A>

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

Formats the value using the given formatter.

impl<'a, A: 'a + Allocator> Deref for AllocatorAdaptor<'a, A>

type Target = A

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, A: 'a + Allocator> GlobalAlloc for AllocatorAdaptor<'a, A>

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

Allocate memory as described by 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 dealloc(&self, ptr: *mut u8, layout: Layout)

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

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.

impl<'a, A: 'a + Allocator> Alloc for AllocatorAdaptor<'a, A>

unsafe fn alloc(&mut self, layout: Layout) -> Result<MemoryAddress, AllocErr>

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

Returns a pointer meeting the size and alignment guarantees of layout.

unsafe fn alloc_zeroed(
    &mut self,
    layout: Layout
) -> Result<MemoryAddress, AllocErr>

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

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

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

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

Deallocate the memory referenced by ptr.

unsafe fn realloc(
    &mut self,
    ptr: MemoryAddress,
    layout: Layout,
    new_size: usize
) -> Result<MemoryAddress, AllocErr>

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

Returns a pointer suitable for holding data described by a new layout with layout’s alignment and a size given by new_size. To accomplish this, this may extend or shrink the allocation referenced by ptr to fit the new layout.

unsafe fn alloc_excess(&mut self, layout: Layout) -> Result<Excess, AllocErr>

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

Behaves like alloc, but also returns the whole size of the returned block. For some layout inputs, like arrays, this may include extra storage usable for additional data.

unsafe fn realloc_excess(
    &mut self,
    ptr: MemoryAddress,
    layout: Layout,
    new_size: usize
) -> Result<Excess, AllocErr>

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

Behaves like realloc, but also returns the whole size of the returned block. For some layout inputs, like arrays, this may include extra storage usable for additional data.

unsafe fn grow_in_place(
    &mut self,
    ptr: MemoryAddress,
    layout: Layout,
    new_size: usize
) -> Result<(), CannotReallocInPlace>

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

Attempts to extend the allocation referenced by ptr to fit new_size.

unsafe fn shrink_in_place(
    &mut self,
    ptr: MemoryAddress,
    layout: Layout,
    new_size: usize
) -> Result<(), CannotReallocInPlace>

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

Attempts to shrink the allocation referenced by ptr to fit new_size.

fn usable_size(&self, layout: &Layout) -> (usize, usize)

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

Returns bounds on the guaranteed usable size of a successful allocation created with the specified layout.

fn alloc_one<T>(&mut self) -> Result<NonNull<T>, AllocErr>

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

Allocates a block suitable for holding an instance of T.

unsafe fn dealloc_one<T>(&mut self, ptr: NonNull<T>)

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

Deallocates a block suitable for holding an instance of T.

fn alloc_array<T>(&mut self, n: usize) -> Result<NonNull<T>, AllocErr>

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

Allocates a block suitable for holding n instances of T.

unsafe fn realloc_array<T>(
    &mut self,
    ptr: NonNull<T>,
    n_old: usize,
    n_new: usize
) -> Result<NonNull<T>, AllocErr>

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

Reallocates a block previously suitable for holding n_old instances of T, returning a block suitable for holding n_new instances of T.

unsafe fn dealloc_array<T>(
    &mut self,
    ptr: NonNull<T>,
    n: usize
) -> Result<(), AllocErr>

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

Deallocates a block suitable for holding n instances of T.