Struct alloc_compose::region::raw::RawSharedRegion

pub struct RawSharedRegion { /* fields omitted */ }

This is supported on crate feature alloc only.

Implementations

impl RawSharedRegion

A clonable region allocator based on Rc.

This is the non-lifetime version of SharedRegion.

pub unsafe fn new(memory: NonNull<[u8]>) -> Self

Creates a new region from the given memory block.

Safety

Behavior is undefined if any of the following conditions are violated:

• memory must be valid for reads and writes for memory.len() many bytes.

• memory must outlive the region.

• memory.len() must be no larger than isize::MAX. See the safety documentation of pointer::offset.

For a safe variant use SharedRegion instead.

Trait Implementations

impl AllocRef for RawSharedRegion

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 RawSharedRegion

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

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

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 allocate_all_zeroed(&self) -> Result<NonNull<[u8]>, AllocError>

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

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 Clone for RawSharedRegion

pub fn clone(&self) -> RawSharedRegion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RawSharedRegion

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

Formats the value using the given formatter.

impl GlobalAlloc for RawSharedRegion

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 RawSharedRegion

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

Returns if the allocator owns the passed memory.

impl PartialEq<RawSharedRegion> for RawSharedRegion

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<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 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 !=.