Struct ImmutableArrayBuilder

pub struct ImmutableArrayBuilder<T: Sized, TAllocator = StdAllocator>
where
    TAllocator: Allocator,
{ /* private fields */ }

A builder for ImmutableArray.

Notes

This struct is very similar to a mutable vec. It is used to construct ImmutableArray incrementally, in place.

Implementations

impl<T: Sized, TAllocator: Allocator> ImmutableArrayBuilder<T, TAllocator>

pub fn shrink_to_fit(&mut self) -> Result<(), ArrayConstructionError>

Shrinks current capacity to the length.

Notes

This method reallocates entire buffer if the current capacity is greater than the length.

Errors

For details see ArrayConstructionError.

pub fn build(self) -> ImmutableArray<T, TAllocator>

Builds the ImmutableArray from the builder.

Notes

This method is basically free. It is here only to move ownership from mutable builder to immutable array.

pub fn new() -> Result<Self, ArrayConstructionError>

Creates a new builder with the default allocator.

Errors

For details see ArrayConstructionError.

pub fn with_allocator( allocator: TAllocator, ) -> Result<Self, ArrayConstructionError>

Creates a new builder with the specified allocator.

Errors

For details see ArrayConstructionError.

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

Pushes a new value to the end of the builder.

Errors

For details see ArrayConstructionError.

pub fn extend_from_array<const N: usize>( &mut self, values: [T; N], ) -> Result<(), ArrayConstructionError>

Extends the builder with the specified values.

Errors

For details see ArrayConstructionError.

pub const fn len(&self) -> Length

pub const fn capacity(&self) -> Length

impl<T: Sized + Clone, TAllocator: Allocator> ImmutableArrayBuilder<T, TAllocator>

pub fn extend_from_slice( &mut self, slice: &[T], ) -> Result<(), ArrayConstructionError>

Extends the builder with the specified slice.

Notes

This method will clone each element one by one.

Errors

For details see ArrayConstructionError.

Trait Implementations

impl<T: Sized, TAllocator: Allocator> Drop for ImmutableArrayBuilder<T, TAllocator>

fn drop(&mut self)

Executes the destructor for this type.