Struct InlineDynamicArray 

pub struct InlineDynamicArray<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 a slightly less efficient variant of DynamicArray.

Similarly to DynamicArray this struct resizes the underlying buffer by multiplying capacity by 3/2.

Implementations

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

where T: Sized, TAllocator: Allocator,

pub fn new() -> Self

where TAllocator: Default,

Creates a new empty InlineDynamicArray with the default TAllocator.

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

Creates a new empty InlineDynamicArray with the given TAllocator.

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

where TAllocator: Default,

Creates a new InlineDynamicArray 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 InlineDynamicArray 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 InlineDynamicArray<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 InlineDynamicArray<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 InlineDynamicArray<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 InlineDynamicArray<TCAPACITY, T, TAllocator>

where TAllocator: Allocator,

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

Mutably borrows from an owned value.

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

where T: TryClone, TAllocator: Allocator + TryClone,

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> Debug for InlineDynamicArray<TCAPACITY, T, TAllocator>

where T: Sized, TAllocator: Allocator,

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

Formats the value using the given formatter.

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

where T: Sized, TAllocator: Allocator + Default,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, const CAPACITY: usize, T: Deserialize<'de>, TAllocator: Allocator + Default> Deserialize<'de> for InlineDynamicArray<CAPACITY, T, TAllocator>

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

where T: Sized, TAllocator: Allocator,

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

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

where T: Eq, TAllocator: Allocator,

impl<const TCAPACITY: usize, T, TAllocator> Hash for InlineDynamicArray<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 InlineDynamicArray<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 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 InlineDynamicArray<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> MutableArray<T> for InlineDynamicArray<TCAPACITY, T, TAllocator>

where T: Sized, TAllocator: Allocator,

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

Tries to push raw array to the array.

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

where T: TryClone,

Tries to push 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 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: TryClone,

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 InlineDynamicArray<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 InlineDynamicArray<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> Send for InlineDynamicArray<TCAPACITY, T, TAllocator>

where T: Sized + Send, TAllocator: Allocator + Send,

impl<const CAPACITY: usize, T: Serialize, TAllocator: Allocator> Serialize for InlineDynamicArray<CAPACITY, T, TAllocator>

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<const TCAPACITY: usize, T, TAllocator> Sync for InlineDynamicArray<TCAPACITY, T, TAllocator>

where T: Sized + Sync, TAllocator: Allocator + Sync,

impl<const TCAPACITY: usize, T, TAllocator> TryClone for InlineDynamicArray<TCAPACITY, T, TAllocator>

where T: TryClone, TAllocator: Allocator + TryClone,

fn try_clone(&self) -> Result<Self, Self::Error>

Tries to clone the array. This is a perfect clone, with exactly the same capacity.

Errors

For details see ArrayError.

type Error = ArrayTryCloneError