Struct dyn_stack::StackReq

pub struct StackReq { /* private fields */ }

Stack allocation requirements.

Implementations

impl StackReq

pub const fn empty() -> StackReq

Allocation requirements for an empty unaligned buffer.

pub const fn new_aligned<T>(n: usize, align: usize) -> StackReq

Allocation requirements sufficient for n elements of type T, overaligned with alignment align.

Panics

• if align is smaller than the minimum required alignment for an object of type T.
• if align is not a power of two.
• if the size computation overflows

pub const fn new<T>(n: usize) -> StackReq

Allocation requirements sufficient for n elements of type T.

Panics

• if the size computation overflows

pub const fn try_new_aligned<T>( n: usize, align: usize ) -> Result<StackReq, SizeOverflow>

Same as StackReq::new_aligned, but returns an error in case the size computation overflows.

Panics

• if align is smaller than the minimum required alignment for an object of type T.
• if align is not a power of two.

pub const fn try_new<T>(n: usize) -> Result<StackReq, SizeOverflow>

Same as StackReq::new, but returns an error in case the size computation overflows.

pub const fn size_bytes(&self) -> usize

The number of allocated bytes required, aligned to self.align_bytes().

pub const fn align_bytes(&self) -> usize

The alignment of allocated bytes required.

pub const fn unaligned_bytes_required(&self) -> usize

The number of allocated bytes required, with no alignment constraints.

Panics

• if the size computation overflows

pub const fn try_unaligned_bytes_required(&self) -> Result<usize, SizeOverflow>

Same as StackReq::unaligned_bytes_required, but returns an error if the size computation overflows.

pub const fn and(self, other: StackReq) -> StackReq

The required allocation to allocate storage sufficient for both of self and other, simultaneously and in any order.

Panics

• if the allocation requirement computation overflows.

pub fn all_of(reqs: impl IntoIterator<Item = StackReq>) -> StackReq

The required allocation to allocate storage sufficient for all the requirements produced by the given iterator, simultaneously and in any order.

Panics

• if the allocation requirement computation overflows.

pub const fn or(self, other: StackReq) -> StackReq

The required allocation to allocate storage sufficient for either of self and other, with only one being active at a time.

Panics

• if the allocation requirement computation overflows.

pub fn any_of(reqs: impl IntoIterator<Item = StackReq>) -> StackReq

The required allocation to allocate storage sufficient for any of the requirements produced by the given iterator, with at most one being active at a time.

Panics

• if the allocation requirement computation overflows.

pub const fn try_and(self, other: StackReq) -> Result<StackReq, SizeOverflow>

Same as StackReq::and, but returns an error if the size computation overflows.

pub fn try_all_of( reqs: impl IntoIterator<Item = StackReq> ) -> Result<StackReq, SizeOverflow>

Same as StackReq::all_of, but returns an error if the size computation overflows.

pub const fn try_or(self, other: StackReq) -> Result<StackReq, SizeOverflow>

Same as StackReq::or, but returns an error if the size computation overflows.

pub fn try_any_of( reqs: impl IntoIterator<Item = StackReq> ) -> Result<StackReq, SizeOverflow>

Same as StackReq::any_of, but returns an error if the size computation overflows.

Trait Implementations

impl Clone for StackReq

fn clone(&self) -> StackReq

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StackReq

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

Formats the value using the given formatter.

impl Default for StackReq

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for StackReq

fn eq(&self, other: &StackReq) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for StackReq

impl Eq for StackReq

impl StructuralEq for StackReq

impl StructuralPartialEq for StackReq