Enum tinyvec::TinyVec

pub enum TinyVec<A: Array> {
    Inline(ArrayVec<A>),
    Heap(Vec<A::Item>),
}

A vector that starts inline, but can automatically move to the heap.

• Requires the alloc feature

Note: This is currently an enum but you can mostly ignore that detail if you like. In future versions this may become an opaque struct, but for now we're being a little more liberal about allowing you to "access the internals" since no safety invariants are on the line. It's kinda wild how much you can just let people poke at stuff without worry when it's 100% safe code.

Variants

Inline(ArrayVec<A>)

Heap(Vec<A::Item>)

Methods

impl<A: Array> TinyVec<A>

pub fn move_to_the_heap(&mut self)

Moves the content of the TinyVec to the heap, if it's inline.

impl<A: Array> TinyVec<A>

pub fn append(&mut self, other: &mut Self)

Move all values from other into this vec.

#[must_use] pub fn as_mut_ptr(&mut self) -> *mut A::Item

A mutable pointer to the backing array.

Safety

This pointer has provenance over the entire backing array/buffer.

#[must_use] pub fn as_mut_slice(&mut self) -> &mut [A::Item]

Helper for getting the mut slice.

#[must_use] pub fn as_ptr(&self) -> *const A::Item

A const pointer to the backing array.

Safety

This pointer has provenance over the entire backing array/buffer.

#[must_use] pub fn as_slice(&self) -> &[A::Item]

Helper for getting the shared slice.

#[must_use] pub fn capacity(&self) -> usize

The capacity of the TinyVec.

This is fixed based on the array type.

pub fn clear(&mut self)

Removes all elements from the vec.

pub fn dedup(&mut self) where
    A::Item: PartialEq, 

De-duplicates the vec.

pub fn dedup_by<F>(&mut self, same_bucket: F) where
    F: FnMut(&mut A::Item, &mut A::Item) -> bool, 

De-duplicates the vec according to the predicate given.

pub fn dedup_by_key<F, K>(&mut self, key: F) where
    F: FnMut(&mut A::Item) -> K,
    K: PartialEq, 

De-duplicates the vec according to the key selector given.

Important traits for TinyVecDrain<'p, A>

impl<'p, A: Array> Iterator for TinyVecDrain<'p, A> type Item = A::Item;

pub fn drain<R: RangeBounds<usize>>(&mut self, range: R) -> TinyVecDrain<A>

Creates a draining iterator that removes the specified range in the vector and yields the removed items.

Panics

• If the start is greater than the end
• If the end is past the edge of the vec.

Example

use tinyvec::*;
let mut tv = tiny_vec!([i32; 4], 1, 2, 3);
let tv2: TinyVec<[i32; 4]> = tv.drain(1..).collect();
assert_eq!(tv.as_slice(), &[1][..]);
assert_eq!(tv2.as_slice(), &[2, 3][..]);

tv.drain(..);
assert_eq!(tv.as_slice(), &[]);

pub fn extend_from_slice(&mut self, sli: &[A::Item]) where
    A::Item: Clone, 

Clone each element of the slice into this vec.

#[must_use] pub fn from_array_len(data: A, len: usize) -> Self

Wraps up an array and uses the given length as the initial length.

Note that the From impl for arrays assumes the full length is used.

Panics

The length must be less than or equal to the capacity of the array.

pub fn insert(&mut self, index: usize, item: A::Item)

Inserts an item at the position given, moving all following elements +1 index.

Panics

• If index > len

Example

use tinyvec::*;
let mut tv = tiny_vec!([i32; 10], 1, 2, 3);
tv.insert(1, 4);
assert_eq!(tv.as_slice(), &[1, 4, 2, 3]);
tv.insert(4, 5);
assert_eq!(tv.as_slice(), &[1, 4, 2, 3, 5]);

#[must_use] pub fn is_empty(&self) -> bool

If the vec is empty.

#[must_use] pub fn len(&self) -> usize

The length of the vec (in elements).

#[must_use] pub fn new() -> Self where
    A: Default, 

Makes a new, empty vec.

pub fn pop(&mut self) -> Option<A::Item>

Remove and return the last element of the vec, if there is one.

Failure

• If the vec is empty you get None.

pub fn push(&mut self, val: A::Item)

Place an element onto the end of the vec.

See also, try_push

Panics

• If the length of the vec would overflow the capacity.

pub fn remove(&mut self, index: usize) -> A::Item

Removes the item at index, shifting all others down by one index.

Returns the removed element.

Panics

If the index is out of bounds.

Example

use tinyvec::*;
let mut tv = tiny_vec!([i32; 4], 1, 2, 3);
assert_eq!(tv.remove(1), 2);
assert_eq!(tv.as_slice(), &[1, 3][..]);

pub fn resize(&mut self, new_len: usize, new_val: A::Item) where
    A::Item: Clone, 

Resize the vec to the new length.

If it needs to be longer, it's filled with clones of the provided value. If it needs to be shorter, it's truncated.

Example

use tinyvec::*;

let mut tv = tiny_vec!([&str; 10], "hello");
tv.resize(3, "world");
assert_eq!(tv.as_slice(), &["hello", "world", "world"][..]);

let mut tv = tiny_vec!([i32; 10], 1, 2, 3, 4);
tv.resize(2, 0);
assert_eq!(tv.as_slice(), &[1, 2][..]);

pub fn resize_with<F: FnMut() -> A::Item>(&mut self, new_len: usize, f: F)

Resize the vec to the new length.

If it needs to be longer, it's filled with repeated calls to the provided function. If it needs to be shorter, it's truncated.

Example

use tinyvec::*;

let mut tv = tiny_vec!([i32; 10], 1, 2, 3);
tv.resize_with(5, Default::default);
assert_eq!(tv.as_slice(), &[1, 2, 3, 0, 0][..]);

let mut tv = tiny_vec!([i32; 10]);
let mut p = 1;
tv.resize_with(4, || {
  p *= 2;
  p
});
assert_eq!(tv.as_slice(), &[2, 4, 8, 16][..]);

pub fn retain<F: FnMut(&A::Item) -> bool>(&mut self, acceptable: F)

Walk the vec and keep only the elements that pass the predicate given.

Example

use tinyvec::*;

let mut tv = tiny_vec!([i32; 10], 1, 2, 3, 4);
tv.retain(|&x| x % 2 == 0);
assert_eq!(tv.as_slice(), &[2, 4][..]);

pub fn split_off(&mut self, at: usize) -> Self where
    A: Default, 

Splits the collection at the point given.

• [0, at) stays in this vec
• [at, len) ends up in the new vec.

Panics

• if at > len

Example

use tinyvec::*;
let mut tv = tiny_vec!([i32; 4], 1, 2, 3);
let tv2 = tv.split_off(1);
assert_eq!(tv.as_slice(), &[1][..]);
assert_eq!(tv2.as_slice(), &[2, 3][..]);

pub fn swap_remove(&mut self, index: usize) -> A::Item

Remove an element, swapping the end of the vec into its place.

Panics

• If the index is out of bounds.

Example

use tinyvec::*;
let mut tv = tiny_vec!([&str; 4], "foo", "bar", "quack", "zap");

assert_eq!(tv.swap_remove(1), "bar");
assert_eq!(tv.as_slice(), &["foo", "zap", "quack"][..]);

assert_eq!(tv.swap_remove(0), "foo");
assert_eq!(tv.as_slice(), &["quack", "zap"][..]);

pub fn truncate(&mut self, new_len: usize)

Reduces the vec's length to the given value.

If the vec is already shorter than the input, nothing happens.

pub fn try_from_array_len(data: A, len: usize) -> Result<Self, A>

Wraps an array, using the given length as the starting length.

If you want to use the whole length of the array, you can just use the From impl.

Failure

If the given length is greater than the capacity of the array this will error, and you'll get the array back in the Err.

Trait Implementations

impl<A: Array> AsMut<[<A as Array>::Item]> for TinyVec<A>

#[must_use] fn as_mut(&mut self) -> &mut [A::Item]

Performs the conversion.

impl<A: Array> AsRef<[<A as Array>::Item]> for TinyVec<A>

#[must_use] fn as_ref(&self) -> &[A::Item]

Performs the conversion.

impl<A: Array> Binary for TinyVec<A> where
    A::Item: Binary, 

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

Formats the value using the given formatter.

impl<A: Array> Borrow<[<A as Array>::Item]> for TinyVec<A>

#[must_use] fn borrow(&self) -> &[A::Item]

Immutably borrows from an owned value.

impl<A: Array> BorrowMut<[<A as Array>::Item]> for TinyVec<A>

#[must_use] fn borrow_mut(&mut self) -> &mut [A::Item]

Mutably borrows from an owned value.

impl<A: Clone + Array> Clone for TinyVec<A> where
    A::Item: Clone, 

fn clone(&self) -> TinyVec<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Array> Debug for TinyVec<A> where
    A::Item: Debug, 

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

Formats the value using the given formatter.

impl<A: Array + Default> Default for TinyVec<A>

#[must_use] fn default() -> Self

Returns the "default value" for a type.

impl<A: Array> Deref for TinyVec<A>

type Target = [A::Item]

The resulting type after dereferencing.

#[must_use] fn deref(&self) -> &Self::Target

Dereferences the value.

impl<A: Array> DerefMut for TinyVec<A>

#[must_use] fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<A: Array> Display for TinyVec<A> where
    A::Item: Display, 

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

Formats the value using the given formatter.

impl<A: Array> Eq for TinyVec<A> where
    A::Item: Eq, 

impl<A: Array> Extend<<A as Array>::Item> for TinyVec<A>

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

Extends a collection with the contents of an iterator.

impl<A: Array> From<ArrayVec<A>> for TinyVec<A>

#[must_use] fn from(arr: ArrayVec<A>) -> Self

Performs the conversion.

impl<A: Array + Default> FromIterator<<A as Array>::Item> for TinyVec<A>

#[must_use] fn from_iter<T: IntoIterator<Item = A::Item>>(iter: T) -> Self

Creates a value from an iterator.

impl<A: Array, I: SliceIndex<[A::Item]>> Index<I> for TinyVec<A>

type Output = <I as SliceIndex<[A::Item]>>::Output

The returned type after indexing.

#[must_use] fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<A: Array, I: SliceIndex<[A::Item]>> IndexMut<I> for TinyVec<A>

#[must_use] fn index_mut(&mut self, index: I) -> &mut Self::Output

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

impl<A: Array> IntoIterator for TinyVec<A>

type Item = A::Item

The type of the elements being iterated over.

type IntoIter = TinyVecIterator<A>

Which kind of iterator are we turning this into?

#[must_use] fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<A: Array> LowerExp for TinyVec<A> where
    A::Item: LowerExp, 

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

Formats the value using the given formatter.

impl<A: Array> LowerHex for TinyVec<A> where
    A::Item: LowerHex, 

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

Formats the value using the given formatter.

impl<A: Array> Octal for TinyVec<A> where
    A::Item: Octal, 

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

Formats the value using the given formatter.

impl<A: Array> Ord for TinyVec<A> where
    A::Item: Ord, 

#[must_use] fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<'_, A: Array> PartialEq<&'_ [<A as Array>::Item]> for TinyVec<A> where
    A::Item: PartialEq, 

#[must_use] fn eq(&self, other: &&[A::Item]) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_, A: Array> PartialEq<&'_ A> for TinyVec<A> where
    A::Item: PartialEq, 

#[must_use] fn eq(&self, other: &&A) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<A: Array> PartialEq<TinyVec<A>> for TinyVec<A> where
    A::Item: PartialEq, 

#[must_use] fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<A: Array> PartialOrd<TinyVec<A>> for TinyVec<A> where
    A::Item: PartialOrd, 

#[must_use] fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<A: Array> Pointer for TinyVec<A> where
    A::Item: Pointer, 

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

Formats the value using the given formatter.

impl<A: Array> UpperExp for TinyVec<A> where
    A::Item: UpperExp, 

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

Formats the value using the given formatter.

impl<A: Array> UpperHex for TinyVec<A> where
    A::Item: UpperHex, 

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

Formats the value using the given formatter.