Struct tinyvec::ArraySet

pub struct ArraySet<A: Array, L> { /* fields omitted */ }

An array-backed set

This set supports O(n) operations and has a fixed size, thus may fail to insert items. The potential advantage is a really small size.

The set is backed by an array of type A and indexed by type L. The item type must support Default. Due to restrictions, L may be only u8 or u16.

Implementations

impl<A: Array + Default, L: From<u8>> ArraySet<A, L>

pub fn new() -> Self

Constructs a new, empty, set

impl<A: Array, L: Copy + Into<usize>> ArraySet<A, L>

pub fn from(arr: A, len: L) -> Self

Constructs a new set from given inputs

Panics if len> arr.len().

impl<A: Array, L> ArraySet<A, L> where
    L: Copy + PartialEq + From<u8> + Into<usize>, 

pub fn capacity(&self) -> usize

Returns the fixed capacity of the set

pub fn len(&self) -> usize

Returns the number of elements in the set

pub fn is_empty(&self) -> bool

Returns true when the set contains no elements

pub fn clear(&mut self)

Removes all elements

pub fn iter(&self) -> Iter<A::Item>ⓘ

Important traits for Iter<'a, T>

impl<'a, T> Iterator for Iter<'a, T> type Item = &'a T;

Iterate over all contents

impl<A: Array, L> ArraySet<A, L> where
    L: Copy + PartialOrd + AddAssign + SubAssign + From<u8> + Into<usize>, 

pub fn contains<Q: Eq + ?Sized>(&self, elt: &Q) -> bool where
    A::Item: Borrow<Q>, 

Check whether the set contains elt

pub fn get<Q: Eq + ?Sized>(&self, elt: &Q) -> Option<&A::Item> where
    A::Item: Borrow<Q>, 

Get a reference to a contained item matching elt

pub fn remove<Q: Eq + ?Sized>(&mut self, elt: &Q) -> Option<A::Item> where
    A::Item: Borrow<Q>, 

Remove an item matching elt, if any

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

Remove any items for which f(item) == false

impl<A: Array, L> ArraySet<A, L> where
    A::Item: Eq,
    L: Copy + PartialOrd + AddAssign + SubAssign + From<u8> + Into<usize>, 

pub fn insert(&mut self, elt: A::Item) -> Result<bool, InsertError>

Insert an item

Due to the fixed size of the backing array, insertion may fail.

pub fn replace(&mut self, elt: A::Item) -> Result<Option<A::Item>, InsertError>

Replace an item matching elt with elt, or insert elt

Returns the replaced item, if any. Fails when there is no matching item and the backing array is full, preventing insertion.

Trait Implementations

impl<A: Clone + Array, L: Clone> Clone for ArraySet<A, L>

fn clone(&self) -> ArraySet<A, L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug + Array, L: Debug> Debug for ArraySet<A, L>

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

Formats the value using the given formatter.

impl<A: Default + Array, L: Default> Default for ArraySet<A, L>

fn default() -> ArraySet<A, L>

Returns the "default value" for a type.