extendr_api::prelude::dyn_stack

Struct DynStack

Source 
pub struct DynStack<'a> { /* private fields */ }
Expand description

Stack wrapper around a buffer of uninitialized bytes.

Implementations§

Source§

impl<'a> DynStack<'a>

Source

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

Returns a new DynStack from the provided memory buffer.

Source

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.

Source

pub fn len_bytes(&self) -> usize

Returns the number of bytes that this stack can hold.

Source

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

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

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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§

Source§

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

Source§

type Target = DynStack<'b>

Source§

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

Auto Trait Implementations§

§

impl<'a> Freeze for DynStack<'a>

§

impl<'a> RefUnwindSafe for DynStack<'a>

§

impl<'a> Send for DynStack<'a>

§

impl<'a> Sync for DynStack<'a>

§

impl<'a> Unpin for DynStack<'a>

§

impl<'a> !UnwindSafe for DynStack<'a>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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> UniversalReborrowMut for T
where T: for<'a> ReborrowMut<'a>,