Struct stack_vec::StackVec4096

pub struct StackVec4096<T>(_, _);

A sized stack vector

Implementations

impl<T> StackVec4096<T>

pub const CAPACITY: usize

The max capacity of this StackVec type

pub const fn cap(&self) -> usize

The max capacity of this StackVec

Note

Identical to Self::CAPACITY, however more convenient for ad-hoc types created through stack![n].

pub fn new() -> Self

Create a new empty StackVec.

pub fn extend_from_slice_copy<U: AsRef<[T]>>(&mut self, slice: U) -> usize where
    T: Copy, 

Extend from a slice where T: Copy.

Returns the number of elements copied. If the copy would overflow the capacity the rest is ignored.

pub fn extend_from_slice<U: AsRef<[T]>>(&mut self, slice: U) -> usize where
    T: Clone, 

Extend from a slice where T: Clone

Returns the number of elements copied. If the copy would overflow the capacity the rest is ignored.

pub fn try_push(&mut self, value: T) -> Result<(), T>

Try to push an element on to the end of the StackVec.

If it is full, return the value as Err(T) instead.

pub fn push(&mut self, value: T)

Push an element on the the end of the StackVec.

Panics

If the StackVec is full.

pub fn len(&self) -> usize

The number of elements currently in the StackVec.

pub fn as_slice(&self) -> &[T]

A slice of the elements in the StackVec.

pub fn as_mut_slice(&mut self) -> &mut [T]

A mutable slice of the elements in the StackVec.

pub fn init_buffer_mut(&mut self) -> &mut [MaybeUninit<T>]

A mutable slice of the initialised part of the buffer.

All elements of the returned slice are initialised.

pub fn init_buffer(&self) -> &[MaybeUninit<T>]

The initialised part of the buffer.

All elements of the returned slice are initialised.

pub unsafe fn rest_mut(&mut self) -> &mut [MaybeUninit<T>]

A mutable reference to the uninitialised part of the instance.

No elements of the returned slice are initialised.

Note

If you initialise some, you must remember to update the length with set_len().

pub fn rest(&self) -> &[MaybeUninit<T>]

The uninitialised part of the instance.

No elements of the returned slice are initialised.

pub unsafe fn buffer_mut(&mut self) -> &mut [MaybeUninit<T>; 4096]

A mutable reference to the whole capacity buffer.

..self.len() will be initialised, self.len().. will be uninitialised.

Note

If you initialise or uninitialise some element(s), you must remember to update the length with set_len().

pub fn buffer(&self) -> &[MaybeUninit<T>; 4096]

A reference to the whole capacity buffer.

..self.len() will be initialised, self.len().. will be uninitialised.

pub unsafe fn set_len(&mut self, len: usize)

Set the internal fill pointer of the StackVec.

This changes how much of the buffer is assumed to be initialised. Only use this if you have manually initialised some of the uninitialised buffer, as it does no initialising itself.

Trait Implementations

impl<T> AsMut<[T]> for StackVec4096<T>

fn as_mut(&mut self) -> &mut [T]

Performs the conversion.

impl<T> AsRef<[T]> for StackVec4096<T>

fn as_ref(&self) -> &[T]

Performs the conversion.

impl<T> Borrow<[T]> for StackVec4096<T>

fn borrow(&self) -> &[T]

Immutably borrows from an owned value.

impl<T> BorrowMut<[T]> for StackVec4096<T>

fn borrow_mut(&mut self) -> &mut [T]

Mutably borrows from an owned value.

impl<T> Clone for StackVec4096<T> where
    T: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for StackVec4096<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T> Default for StackVec4096<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T> Deref for StackVec4096<T>

type Target = [T]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for StackVec4096<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> Drop for StackVec4096<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Eq for StackVec4096<T> where
    T: Eq, 

impl<T> From<[T; 4096]> for StackVec4096<T>

fn from(from: [T; 4096]) -> Self

Performs the conversion.

impl<T> From<StackVec4096<T>> for Vec<T>

fn from(from: StackVec4096<T>) -> Self

Performs the conversion.

impl<T> FromIterator<T> for StackVec4096<T>

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<T, I: SliceIndex<[T]>> Index<I> for StackVec4096<T>

type Output = I::Output

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, I: SliceIndex<[T]>> IndexMut<I> for StackVec4096<T>

fn index_mut(&mut self, index: I) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T> IntoIterator for StackVec4096<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = StackVec4096IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> Ord for StackVec4096<T> where
    T: Ord, 

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T, U> PartialEq<U> for StackVec4096<T> where
    T: PartialEq,
    U: AsRef<[T]>, 

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T, U> PartialOrd<U> for StackVec4096<T> where
    T: PartialOrd,
    U: AsRef<[T]>, 

fn partial_cmp(&self, other: &U) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Write for StackVec4096<u8>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this writer.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn is_write_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Writeer has an efficient write_vectored implementation.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.