Struct extendr_api::prelude::dyn_stack::DynStack

pub struct DynStack<'a> {
    pub(crate) buffer: &'a mut [MaybeUninit<u8>],
}

Stack wrapper around a buffer of uninitialized bytes.

Fields

buffer: &'a mut [MaybeUninit<u8>]

Implementations

impl<'a> DynStack<'a>

pub fn new(buffer: &'a mut [MaybeUninit<u8>]) -> DynStack<'a>

Returns a new DynStack from the provided memory buffer.

pub fn can_hold(&self, alloc_req: StackReq) -> bool

Returns true if the stack can hold an allocation with the given size and alignment requirements.

pub fn len_bytes(&self) -> usize

Returns the number of bytes that this stack can hold.

pub fn as_ptr(&self) -> *const u8

Returns a pointer to the (possibly uninitialized) stack memory.

pub fn make_aligned_uninit<T>( self, size: usize, align: usize, ) -> (DynArray<'a, MaybeUninit<T>>, DynStack<'a>)

Returns a new aligned and uninitialized DynArray and a stack over the remainder of the buffer.

Panics

Panics if the stack isn’t large enough to allocate the array.

pub fn make_aligned_with<T, F>( self, size: usize, align: usize, f: F, ) -> (DynArray<'a, T>, DynStack<'a>)

where F: FnMut(usize) -> T,

Returns a new aligned DynArray, initialized with the provided function, and a stack over the remainder of the buffer.

Panics

Panics if the stack isn’t large enough to allocate the array, or if the provided function panics.

pub fn make_uninit<T>( self, size: usize, ) -> (DynArray<'a, MaybeUninit<T>>, DynStack<'a>)

Returns a new uninitialized DynArray and a stack over the remainder of the buffer.

Panics

Panics if the stack isn’t large enough to allocate the array.

pub fn make_with<T, F>( self, size: usize, f: F, ) -> (DynArray<'a, T>, DynStack<'a>)

where F: FnMut(usize) -> T,

Returns a new DynArray, initialized with the provided function, and a stack over the remainder of the buffer.

Panics

Panics if the stack isn’t large enough to allocate the array, or if the provided function panics.

pub fn collect_aligned<I>( self, align: usize, iter: I, ) -> (DynArray<'a, <I as IntoIterator>::Item>, DynStack<'a>)

where I: IntoIterator,

Returns a new aligned DynArray, initialized with the provided iterator, and a stack over the remainder of the buffer.
If there isn’t enough space for all the iterator items, then the returned array only contains the first elements that fit into the stack.

Panics

Panics if the provided iterator panics.

pub fn collect<I>( self, iter: I, ) -> (DynArray<'a, <I as IntoIterator>::Item>, DynStack<'a>)

where I: IntoIterator,

Returns a new DynArray, initialized with the provided iterator, and a stack over the remainder of the buffer.
If there isn’t enough space for all the iterator items, then the returned array only contains the first elements that fit into the stack.

Panics

Panics if the provided iterator panics.

Trait Implementations

impl<'a, 'b> ReborrowMut<'b> for DynStack<'a>

where 'a: 'b,

type Target = DynStack<'b>

fn rb_mut(&'b mut self) -> <DynStack<'a> as ReborrowMut<'b>>::Target