Struct fixed_slice_vec::vec::FixedSliceVec

pub struct FixedSliceVec<'a, T: Sized> { /* fields omitted */ }

Vec-like structure backed by a storage slice of possibly uninitialized data.

The maximum length (the capacity) is fixed at runtime to the length of the provided storage slice.

Implementations

impl<'a, T: Sized> FixedSliceVec<'a, T>

pub fn new(storage: &'a mut [MaybeUninit<T>]) -> Self

Create a SliceVec backed by a slice of possibly-uninitialized data. The backing storage slice is used as capacity for Vec-like operations,

The initial length of the SliceVec is 0.

pub fn from_bytes(bytes: &'a mut [u8]) -> FixedSliceVec<'a, T>

Create a well-aligned SliceVec backed by a slice of the provided bytes. The slice is as large as possible given the item type and alignment of the provided bytes.

If you are interested in recapturing the prefix and suffix bytes on either side of the carved-out SliceVec buffer, consider using align_from_bytes instead:

let vec = fixed_slice_vec::FixedSliceVec::from_bytes(&mut bytes[..]);

The bytes are treated as if they might be uninitialized, so even if T is u8, the length of the returned SliceVec will be zero.

pub fn from_uninit_bytes(
    bytes: &'a mut [MaybeUninit<u8>]
) -> FixedSliceVec<'a, T>

Create a well-aligned SliceVec backed by a slice of the provided uninitialized bytes. The typed slice is as large as possible given its item type and the alignment of the provided bytes.

If you are interested in recapturing the prefix and suffix bytes on either side of the carved-out SliceVec buffer, consider using align_from_uninit_bytes:

pub fn align_from_bytes(
    bytes: &'a mut [u8]
) -> (&'a mut [u8], FixedSliceVec<'a, T>, &'a mut [u8])

Create a well-aligned SliceVec backed by a slice of the provided bytes. The slice is as large as possible given the item type and alignment of the provided bytes. Returns the unused prefix and suffix bytes on either side of the carved-out SliceVec.

let mut bytes = [3u8, 1, 4, 1, 5, 9];
let (prefix, vec, suffix) = fixed_slice_vec::FixedSliceVec::align_from_bytes(&mut bytes[..]);
let vec: fixed_slice_vec::FixedSliceVec<u16> = vec;

The bytes are treated as if they might be uninitialized, so even if T is u8, the length of the returned SliceVec will be zero.

pub fn align_from_uninit_bytes(
    bytes: &'a mut [MaybeUninit<u8>]
) -> (&'a mut [MaybeUninit<u8>], FixedSliceVec<'a, T>, &'a mut [MaybeUninit<u8>])

Create a well-aligned SliceVec backed by a slice of the provided bytes. The slice is as large as possible given the item type and alignment of the provided bytes. Returns the unused prefix and suffix bytes on either side of the carved-out SliceVec.

let mut bytes: [MaybeUninit<u8>; 15] = unsafe { MaybeUninit::uninit().assume_init() };
let (prefix, vec, suffix) = fixed_slice_vec::FixedSliceVec::align_from_uninit_bytes(&mut
bytes[..]);
let vec: fixed_slice_vec::FixedSliceVec<u16> = vec;

The length of the returned SliceVec will be zero.

pub fn len(&self) -> usize

The length of the SliceVec. The number of initialized values that have been added to it.

pub fn capacity(&self) -> usize

The maximum amount of items that can live in this SliceVec

pub fn is_empty(&self) -> bool

Returns true if there are no items present.

pub fn is_full(&self) -> bool

Returns true if the SliceVec is full to capacity.

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

Attempt to add a value to the SliceVec.

Returns an error if there is not enough capacity to hold another item.

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

Attempt to add a value to the SliceVec.

Panics

Panics if there is not sufficient capacity to hold another item.

pub fn pop(&mut self) -> Option<T>

Remove the last item from the SliceVec.

pub fn clear(&mut self)

Removes the SliceVec's tracking of all items in it while retaining the same capacity.

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

Obtain an immutable slice view on the initialized portion of the SliceVec.

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

Obtain a mutable slice view on the initialized portion of the SliceVec.

Trait Implementations

impl<'a, T: Sized> AsMut<[T]> for FixedSliceVec<'a, T>

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

Performs the conversion.

impl<'a, T: Sized> AsRef<[T]> for FixedSliceVec<'a, T>

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

Performs the conversion.

impl<'a, T: Sized> Borrow<[T]> for FixedSliceVec<'a, T>

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

Immutably borrows from an owned value.

impl<'a, T: Sized> BorrowMut<[T]> for FixedSliceVec<'a, T>

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

Mutably borrows from an owned value.

impl<'a, T: Sized> Debug for FixedSliceVec<'a, T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<'a, T: Sized> Deref for FixedSliceVec<'a, T>

type Target = [T]

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, T: Sized> DerefMut for FixedSliceVec<'a, T>

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

Mutably dereferences the value.

impl<'a, T: Sized> Drop for FixedSliceVec<'a, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T: Sized> Eq for FixedSliceVec<'a, T> where
    T: Eq, 

impl<'a, T: Sized> From<&'a mut [MaybeUninit<T>]> for FixedSliceVec<'a, T>

fn from(v: &'a mut [MaybeUninit<T>]) -> Self

Performs the conversion.

impl<'a, T: Sized> From<&'a mut [T]> for FixedSliceVec<'a, T>

fn from(v: &'a mut [T]) -> Self

Performs the conversion.

impl<'a, T: Sized> Hash for FixedSliceVec<'a, T> where
    T: Hash, 

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'a, T: Sized> PartialEq<[T]> for FixedSliceVec<'a, T> where
    T: PartialEq, 

fn eq(&self, other: &[T]) -> 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<'a, T: Sized> PartialEq<FixedSliceVec<'a, T>> for FixedSliceVec<'a, T> where
    T: PartialEq, 

fn eq(&self, other: &Self) -> 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<'a, T: Sized> PartialOrd<FixedSliceVec<'a, T>> for FixedSliceVec<'a, T> where
    T: PartialOrd, 

fn partial_cmp(&self, other: &FixedSliceVec<'a, T>) -> Option<Ordering>

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

fn lt(&self, other: &Self) -> bool

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

fn le(&self, other: &Self) -> bool

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

fn gt(&self, other: &Self) -> bool

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

fn ge(&self, other: &Self) -> bool

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