Struct InlineArray 

pub struct InlineArray<const TCAPACITY: usize, T, TAllocator>
where
    T: Sized,
    TAllocator: Allocator,
{ /* private fields */ }

Represents a dynamic array, where first TCAPACITY items are inlined in the struct itself.

In other words, this array allocates memory only when its length exceeds TCAPACITY. In which case it allocates data on heap, and becomes pretty much a DynamicArray.

Implementations

impl<const TCAPACITY: usize, T, TAllocator> InlineArray<TCAPACITY, T, TAllocator>

where T: Sized, TAllocator: Allocator,

pub fn new() -> Self

Creates a new empty InlineArray with the default TAllocator.

pub const fn with_allocator(allocator: TAllocator) -> Self

Creates a new empty InlineArray with the given TAllocator.

pub fn with_capacity(capacity: Length) -> Result<Self, ArrayError>

Creates a new InlineArray with the default TAllocator. This method allocates memory if capacity exceeds TCAPACITY.

Errors

For details see ArrayError.

pub fn with_capacity_and_allocator( capacity: Length, allocator: TAllocator, ) -> Result<Self, ArrayError>

Creates a new InlineArray with the given TAllocator. This method allocates memory if capacity exceeds TCAPACITY.

Errors

For details see ArrayError.

Trait Implementations

impl<const TCAPACITY: usize, T, TAllocator> AsMut<[T]> for InlineArray<TCAPACITY, T, TAllocator>

where TAllocator: Allocator,

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<const TCAPACITY: usize, T, TAllocator> AsRef<[T]> for InlineArray<TCAPACITY, T, TAllocator>

where TAllocator: Allocator,

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

Converts this type into a shared reference of the (usually inferred) input type.

impl<const TCAPACITY: usize, T, TAllocator> Borrow<[T]> for InlineArray<TCAPACITY, T, TAllocator>

where TAllocator: Allocator,

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

Immutably borrows from an owned value.

impl<const TCAPACITY: usize, T, TAllocator> BorrowMut<[T]> for InlineArray<TCAPACITY, T, TAllocator>

where TAllocator: Allocator,

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

Mutably borrows from an owned value.

impl<const TCAPACITY: usize, T: Clone, TAllocator> Clone for InlineArray<TCAPACITY, T, TAllocator>

where TAllocator: Allocator,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const TCAPACITY: usize, T, TAllocator> Default for InlineArray<TCAPACITY, T, TAllocator>

where T: Sized, TAllocator: Allocator,

fn default() -> Self

Returns the “default value” for a type.

impl<const TCAPACITY: usize, T, TAllocator> Drop for InlineArray<TCAPACITY, T, TAllocator>

where T: Sized, TAllocator: Allocator,

fn drop(&mut self)

Executes the destructor for this type.

impl<const TCAPACITY: usize, T, TAllocator> Hash for InlineArray<TCAPACITY, T, TAllocator>

where T: Hash, TAllocator: Allocator,

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const TCAPACITY: usize, T, TAllocator> ImmutableArray<T> for InlineArray<TCAPACITY, T, TAllocator>

where T: Sized, TAllocator: Allocator,

fn length(&self) -> Length

Returns array’s length as [Length].

fn capacity(&self) -> Length

Returns the current capacity for holding items in the array.

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

Represents the array as immutable slice.

fn is_empty(&self) -> bool

Returns true if array is empty, false otherwise. Should be consistent with self.length() == Length::ZERO check.

impl<const TCAPACITY: usize, T, TAllocator> Index<Length> for InlineArray<TCAPACITY, T, TAllocator>

where T: Sized, TAllocator: Allocator,

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<const TCAPACITY: usize, T, TAllocator> IndexMut<Length> for InlineArray<TCAPACITY, T, TAllocator>

where T: Sized, TAllocator: Allocator,

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

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

impl<const TCAPACITY: usize, T, TAllocator> MutableArray<T> for InlineArray<TCAPACITY, T, TAllocator>

where T: Sized, TAllocator: Allocator,

fn try_push_array<const TSIZE: usize>( &mut self, arr: [T; TSIZE], ) -> Result<(), ArrayError>

Pushes raw array to the array.

fn try_push_slice(&mut self, slice: &[T]) -> Result<(), ArrayError>

where T: Clone,

Pushes slice to the array. This method requires Clone trait on T.

fn try_pop(&mut self) -> Result<T, ArrayIsEmptyError>

Removes element from the top of the array.

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

Represents the array as mutable slice.

fn pop(&mut self) -> T

Removes element from the top of the array.

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

Pushes a single element to the array.

fn push_array<const TSIZE: usize>(&mut self, arr: [T; TSIZE])

Pushes raw array to the array.

fn push_slice(&mut self, slice: &[T])

where T: Clone,

Pushes raw slice to the array. This method requires Clone trait on T.

fn push(&mut self, value: T)

Pushes a single element to the array.

impl<const TCAPACITY: usize, T, TAllocator, Rhs> PartialEq<Rhs> for InlineArray<TCAPACITY, T, TAllocator>

where T: PartialEq, TAllocator: Allocator, Rhs: AsRef<[T]>,

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const TCAPACITY: usize, T, TAllocator> ReprC for InlineArray<TCAPACITY, T, TAllocator>

where T: Sized + ReprC, TAllocator: Allocator,

const CHECK: ()

This field is used for const checks only.

impl<const TCAPACITY: usize, T, TAllocator> Eq for InlineArray<TCAPACITY, T, TAllocator>

where T: Eq, TAllocator: Allocator,