Struct alloc_compose::region::SharedRegion

pub struct SharedRegion<'mem> { /* fields omitted */ }

This is supported on crate feature alloc only.

A clonable region allocator based on Rc.

It holds a lifetime to the provided memory block, which ensures, that the allocator does not outlive the underlying memory.

For a version without lifetime see RawSharedRegion instead.

Implementations

impl<'mem> SharedRegion<'mem>

pub fn new(memory: &'mem mut [MaybeUninit<u8>]) -> Self

Creates a new region from the given memory block.

Trait Implementations

impl<'_> AllocRef for SharedRegion<'_>

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

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

Attempts to allocate a block of memory.

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

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

Deallocates the memory referenced by ptr.

pub 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.

pub 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.

pub 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.

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

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

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

pub fn by_ref(&self) -> &Self

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

Creates a "by reference" adaptor for this instance of AllocRef.

impl<'_> AllocateAll for SharedRegion<'_>

pub fn allocate_all(&self) -> Result<NonNull<[u8]>, AllocError>

Attempts to allocate all of the memory the allocator can provide.

pub fn allocate_all_zeroed(&self) -> Result<NonNull<[u8]>, AllocError>

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

pub fn deallocate_all(&self)

Deallocates all the memory the allocator had allocated.

pub fn capacity(&self) -> usize

Returns the total capacity available in this allocator.

pub fn capacity_left(&self) -> usize

Returns the free capacity left for allocating.

pub fn is_empty(&self) -> bool

Returns if the allocator is currently not holding memory.

pub fn is_full(&self) -> bool

Returns if the allocator has no more capacity left.

impl<'mem> Clone for SharedRegion<'mem>

pub fn clone(&self) -> SharedRegion<'mem>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'_> GlobalAlloc for SharedRegion<'_>

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

Allocate memory as described by the given layout.

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

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

pub 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.

pub 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<'_> Owns for SharedRegion<'_>

pub fn owns(&self, memory: NonNull<[u8]>) -> bool

Returns if the allocator owns the passed memory.

impl<'_> PartialEq<RawSharedRegion> for SharedRegion<'_>

pub fn eq(&self, rhs: &RawSharedRegion) -> bool

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

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

This method tests for !=.

impl<'_> PartialEq<SharedRegion<'_>> for SharedRegion<'_>

pub fn eq(&self, rhs: &Self) -> bool

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

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

This method tests for !=.

impl<'_> PartialEq<SharedRegion<'_>> for RawSharedRegion

pub fn eq(&self, rhs: &SharedRegion<'_>) -> bool

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

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

This method tests for !=.