Skip to main content

ArenaAllocator

Struct ArenaAllocator 

Source
pub struct ArenaAllocator<S: MemoryDescriptor> { /* private fields */ }
Expand description

Arena allocator backed by an instance of a MemoryDescriptor object.

This struct wraps an Allocator from the offset_allocator crate, and provides methods for allocating memory from the storage.

The allocator is thread-safe, and the storage is shared between the allocator and the buffers.

Implementations§

Source§

impl<S: MemoryDescriptor> ArenaAllocator<S>

Source

pub fn new(storage: S, page_size: usize) -> Result<Self, ArenaError>

Create a new ArenaAllocator from a MemoryDescriptor object and a page size.

The page size must be a power of two.

The allocator will divide the storage into pages and allocations will consist of a set of contiguous pages whose aggregate size is greater than or equal to the requested size.

The allocator is thread-safe, and the storage is shared between the allocator and the buffers.

Source

pub fn allocate(&self, size: usize) -> Result<ArenaBuffer<S>, ArenaError>

Allocates a new ArenaBuffer of the given size from this allocator.

The actual allocation may consume more pages than strictly needed due to page-size rounding. Returns ArenaError::AllocationFailed if there are not enough contiguous pages available.

Trait Implementations§

Source§

impl<S: Clone + MemoryDescriptor> Clone for ArenaAllocator<S>

Source§

fn clone(&self) -> ArenaAllocator<S>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<S: MemoryDescriptor> Debug for ArenaAllocator<S>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<S> Freeze for ArenaAllocator<S>

§

impl<S> RefUnwindSafe for ArenaAllocator<S>
where S: RefUnwindSafe,

§

impl<S> Send for ArenaAllocator<S>

§

impl<S> Sync for ArenaAllocator<S>

§

impl<S> Unpin for ArenaAllocator<S>

§

impl<S> UnsafeUnpin for ArenaAllocator<S>

§

impl<S> UnwindSafe for ArenaAllocator<S>
where S: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more