Struct brownstone::builder::ArrayBuilder

pub struct ArrayBuilder<T, const N: usize> { /* fields omitted */ }

Low-level builder type for [T; N] arrays. Uses a push + finish interface to build an array 1 element at a time.

The interface provided by this type is fairly low level; most of its methods are fallible in some way (returning a Result or panicking on errors). Consider instead the misuse-resistant move_builder::ArrayBuilder, which uses ownership semantics to provide only infallible operations, or the builder functions at the top-level of the crate.

Implementations

impl<T, const N: usize> ArrayBuilder<T, N>

pub const fn new() -> Self

Create a new, empty ArrayBuilder

pub fn is_full(&self) -> bool

Returns true if every element in the array is initialized. If the builder is full, the next call to finish will return the built array.

pub fn is_empty(&self) -> bool

Returns true if no elements in the array are initialized.

pub fn len(&self) -> usize

Returns the number of initialized elements in the array

pub unsafe fn push_unchecked(&mut self, value: T) -> PushResult

Add an initialized element to the array, without performing a bounds check.

Safety

This must only be called when the builder is not full

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

Try to add an initialized element to the array. Returns an error if the array is already full.

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

Add an initialized element to the array.

Panics

Panics if the array is already full

pub unsafe fn finish_unchecked(self) -> [T; N]

Return the fully initialized array without checking that it’s fully initialized.

Safety

This must only be called when the builder is full.

pub fn try_finish(self) -> Result<[T; N], Self>

Try to return the fully initialized array. Returns the builder if the array isn’t fully initialized yet.

pub fn finish(self) -> [T; N]

Return the fully initialized array.

Panics

Panics if the array isn’t fully initialized yet.

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

Get the slice of the array that has already been initialized.

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

Get the mutable slice of the array that has already been initialized.

Trait Implementations

impl<T: Clone, const N: usize> Clone for ArrayBuilder<T, N>

fn clone(&self) -> ArrayBuilder<T, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, const N: usize> Debug for ArrayBuilder<T, N>

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

Formats the value using the given formatter.

impl<T, const N: usize> Default for ArrayBuilder<T, N>

fn default() -> Self

Returns the “default value” for a type.

impl<T, const N: usize> Extend<T> for ArrayBuilder<T, N>

fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.