Struct PodStack

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

Stack wrapper around a buffer of bytes.

Fields

buffer: &'a mut [u8]

Implementations

impl<'a> PodStack<'a>

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

Returns a new PodStack 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 stack memory.

pub fn make_aligned_raw<T>( self, size: usize, align: usize, ) -> (&'a mut [T], PodStack<'a>)

where T: Pod,

Returns a new aligned and uninitialized slice 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, ) -> (&'a mut [T], PodStack<'a>)

where T: Pod, F: FnMut(usize) -> T,

Returns a new aligned slice, 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_raw<T>(self, size: usize) -> (&'a mut [T], PodStack<'a>)

where T: Pod,

Returns a new uninitialized slice 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) -> (&'a mut [T], PodStack<'a>)

where T: Pod, F: FnMut(usize) -> T,

Returns a new slice, 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, ) -> (&'a mut [<I as IntoIterator>::Item], PodStack<'a>)

where I: IntoIterator, <I as IntoIterator>::Item: Pod,

Returns a new aligned slice, 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, ) -> (&'a mut [<I as IntoIterator>::Item], PodStack<'a>)

where I: IntoIterator, <I as IntoIterator>::Item: Pod,

Returns a new slice, 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 PodStack<'a>

where 'a: 'b,

type Target = PodStack<'b>

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