Struct ArrayUninit

pub struct ArrayUninit<T, const CAP: usize, S: Storage = Bare> { /* private fields */ }

Available on crate feature unsafe_array only.

A static array allowing uninitialized elements.

Implementations

impl<T, const CAP: usize, S: Storage> ArrayUninit<T, CAP, S>

pub fn new() -> Self

Returns a new uninitialized empty array.

pub fn from_range<I>(iterator: I) -> Result<Self, PartialSpace>

where I: IntoIterator<Item = T>,

Initializes the array from an iterator until it’s either full or the iterator is exhausted.

Returns

• Returns a new array initialized with the elements from the iterator.
• Returns PartiallyAdded if not all elements could be initialized.
• Returns NotEnoughSpace if the array had no uninitialized elements.

pub const fn len(&self) -> usize

Returns the count of initialized elements.

pub const fn is_empty(&self) -> bool

Returns true if no elements are yet initialized.

pub const fn is_full(&self) -> bool

Returns true if all the elements are already initialized.

pub const fn verify_index( &self, index: usize, ) -> Result<usize, IndexOutOfBounds>

Returns index back if it’s within the range already initialized.

Errors

Returns IndexOutOfBounds if the index is larger than the initialized length.

pub fn get(&self, index: usize) -> Result<&T, IndexOutOfBounds>

Returns a shared reference to an initialized element at a given index.

Errors

Returns IndexOutOfBounds if the index is larger than the initialized length. or if the element at that index is not initialized.

pub fn get_mut(&mut self, index: usize) -> Result<&mut T, IndexOutOfBounds>

Returns an exclusive reference to an initialized element at a given index.

Errors

Returns IndexOutOfBounds if the index is larger than the initialized length. or if the element at that index is not initialized.

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

Initializes the next uninitialized element with the provided value.

Errors

Returns IndexOutOfBounds if the index is larger than the initialized length.

pub fn init_range<I>(&mut self, values: I) -> Result<usize, PartialSpace>

where I: IntoIterator<Item = T>,

Initializes elements from an iterator

Starts at the last initialized element, continues until either the array is full or the iterator is exhausted.

Returns

• Returns the number of elements initialized.
• Returns PartiallyAdded if not all elements could be initialized.
• Returns NotEnoughSpace if the array had no uninitialized elements.

pub fn replace(&mut self, index: usize, value: T) -> Result<T, IndexOutOfBounds>

Replaces the value at a given index with a new value and returns the old value.

Errors

Returns IndexOutOfBounds if the index is not within the range of initialized elements.

pub fn swap( &mut self, index1: usize, index2: usize, ) -> Result<(), IndexOutOfBounds>

Swaps the values at two indices.

Errors

Returns IndexOutOfBounds if either index is not within the range of initialized elements.

Trait Implementations

impl<T: Default, const CAP: usize, S: Default + Storage> Default for ArrayUninit<T, CAP, S>

where S::Stored<[MaybeUninit<T>; CAP]>: Default,

fn default() -> ArrayUninit<T, CAP, S>

Returns the “default value” for a type.