Struct fdf::Arena

pub struct Arena(/* private fields */);

Implements a memory arena allocator to be used with the Fuchsia Driver Runtime when sending and receiving from channels.

Implementations

impl Arena

pub fn new() -> Result<Self, Status>

Allocates a new arena for use with the driver runtime

pub unsafe fn from_raw(ptr: NonNull<fdf_arena_t>) -> Self

Creates an arena from a raw pointer to the arena object.

Safety

The caller is responsible for ensuring that only one Arena is constructed from this pointer, and that is has not previously been freed.

pub fn contains_ptr<T: ?Sized>(&self, ptr: &T) -> bool

Returns true if the allocation pointed to was made by this arena

pub fn contains<T: ?Sized>(&self, item: &ArenaBox<'_, T>) -> bool

Returns true if the allocation was made by this arena

pub fn insert_uninit<T: Sized>(&self) -> ArenaBox<'_, MaybeUninit<T>>

Inserts a MaybeUninit object and returns the ArenaBox of it.

pub fn insert_uninit_slice<T: Sized>( &self, len: usize, ) -> ArenaBox<'_, [MaybeUninit<T>]>

Inserts a slice of MaybeUninit objects of len len

Panics

Panics if an array [T; n] is too large to be allocated.

pub fn insert<T: Sized>(&self, obj: T) -> ArenaBox<'_, T>

Moves obj of type T into the arena and returns an ArenaBox containing the moved value.

pub fn insert_boxed_slice<T: Sized>(&self, slice: Box<[T]>) -> ArenaBox<'_, [T]>

Moves a Boxed slice into the arena and returns an ArenaBox containing the moved value.

pub fn insert_slice<T: Sized + Clone>(&self, slice: &[T]) -> ArenaBox<'_, [T]>

Copies the slice into the arena and returns an ArenaBox containing the copied values.

pub fn insert_default_slice<T: Sized + Default>( &self, len: usize, ) -> ArenaBox<'_, [T]>

Inserts a slice of Default-initialized objects of type T to the arena and returns an ArenaBox of it.

Panics

Panics if an array [T; n] is too large to be allocated.

pub unsafe fn assume_unchecked<T: ?Sized>( &self, ptr: NonNull<T>, ) -> ArenaBox<'_, T>

Returns an ArenaBox for the pointed to object, assuming that it is part of this arena.

Safety

This does not verify that the pointer came from this arena, so the caller is responsible for verifying that.

pub unsafe fn assume<T: ?Sized>(&self, ptr: NonNull<T>) -> ArenaBox<'_, T>

Returns an ArenaBox for the pointed to object, verifying that it is a part of this arena in the process.

Panics

This function panics if the given pointer is not in this Arena.

Safety

The caller is responsible for ensuring that only one ArenaBox is constructed for a given pointer, and that the pointer originated from an ArenaBox<T> or a direct allocation with the arena through fdf_arena_allocate, and is:

• initialized to a value of T.
• properly aligned for T.
• pointing to the beginning of the object, and not to a subfield of another ArenaBoxed object.

pub fn make_rc<T: ?Sized>(&self, data: ArenaBox<'_, T>) -> ArenaRc<T>

Moves the given ArenaBox into an ArenaRc with an owned reference to this Arena, allowing for it to be used in 'static contexts.

Panics

Panics if the given ArenaBox is not allocated from this arena.

pub fn make_static<T: ?Sized>(&self, data: ArenaBox<'_, T>) -> ArenaStaticBox<T>

Moves the given ArenaBox into an ArenaStaticBox with an owned reference to this Arena, allowing for it to be used in 'static contexts.

Panics

Panics if the given ArenaBox is not allocated from this arena.

pub fn insert_from_iter<I: IntoIterator>( &self, source: I, ) -> ArenaBox<'_, [I::Item]>

where I::IntoIter: ExactSizeIterator,

Creates an ArenaBoxed slice from an iterator implementing ExactSizeIterator. Note that if ExactSizeIterator::len returns an incorrect value, the returned ArenaBox will be no more than the length returned, and may be less.

pub fn try_insert_from_iter<I, T, E>( &self, source: I, ) -> Result<ArenaBox<'_, [T]>, E>

where I: IntoIterator<Item = Result<T, E>>, I::IntoIter: ExactSizeIterator,

Tries to create an ArenaBoxed slice from an iterator implementing ExactSizeIterator. Note that if ExactSizeIterator::len returns an incorrect value, the returned ArenaBox will be no more than the length returned, and may be less.

If any item returned by the iterator returns an Err() result, results so far are discarded

pub fn into_raw(self) -> NonNull<fdf_arena_t>

Transforms this Arena into an fdf_arena_t without dropping the reference.

If the caller drops the returned fdf_arena_t, the memory allocated by the arena will never be freed.

Trait Implementations

impl Clone for Arena

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Arena

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

Formats the value using the given formatter.

impl Drop for Arena

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Arena

impl Sync for Arena