Struct Collection 

pub struct Collection<In, Ix, S = HashMap<Key, In, DefaultHashBuilder>> { /* private fields */ }

A collection of items, with an index that is automatically kept up-to-date.

Implementations

impl<In, Ix> Collection<In, Ix>

pub fn new(ix: Ix) -> Self

where In: 'static, Ix: Index<In>, HashMap<Key, In, DefaultHashBuilder>: Store<In>,

Create an empty collection.

impl<In, Ix, S: Default> Collection<In, Ix, S>

pub fn new_with_empty_store(ix: Ix) -> Self

Create an empty collection.

impl<In, Ix, S> Collection<In, Ix, S>

where S: Store<In>, In: 'static, Ix: Index<In>,

pub fn new_with_store(store: S, ix: Ix) -> Self

Create a collection with a custom store.

If the store is non-empty, the indexes will be populated from the store’s contents. So this may be an expensive operation depending on the size of the store.

impl<In, Ix, S> Collection<In, Ix, S>

pub fn store(&self) -> &S

Access the underlying store.

pub fn extract_store(self) -> S

Extract the underlying store.

pub fn unsafe_mut_store(&mut self) -> &mut S

Mutably access the underlying store. Warning: Mutating the elements inside the store may lead to inconsistencies with the index and cause undefined behavior. Use with caution. Ideally - only use it in a way that doesn’t modify the elements.

impl<In, Ix, S> Collection<In, Ix, S>

where In: 'static, Ix: Index<In>, S: Store<In>,

pub fn get_by_key(&self, key: Key) -> Option<&In>

Lookup an item in the collection by its key.

pub fn insert(&mut self, value: In) -> Key

Insert a new item into the collection.

pub fn insert_all<I>(&mut self, iter: I)

where I: Iterator<Item = In>,

Insert all items from an iterator into the collection.

pub fn iter(&self) -> impl Iterator<Item = (Key, &In)>

Iterate over all items in the collection.

pub fn update_by_key_mut<F>(&mut self, key: Key, f: F)

where F: FnOnce(&mut Option<In>),

Mutate (or alter the presence of) the item in the collection.

pub fn update_by_key<F>(&mut self, key: Key, f: F)

where F: FnOnce(Option<&In>) -> In,

Update the item in the collection.

pub fn adjust_by_key_mut<F>(&mut self, key: Key, f: F)

where F: FnOnce(&mut In),

Mutate the item in the collection, if it exists.

pub fn adjust_by_key<F>(&mut self, key: Key, f: F)

where F: FnOnce(&In) -> In,

Adjust the item in the collection, if it exists.

pub fn delete_by_key(&mut self, key: Key) -> Option<In>

Remove an item from the collection, returning it if it exists.

pub fn query<Res>(&self, f: impl FnOnce(&Ix) -> Res) -> Res::Resolved<&In>

where Res: QueryResult,

Perform a query using the collection’s indexes, returning references to the items.

pub fn query_keys<Res>(&self, f: impl FnOnce(&Ix) -> Res) -> Res::Resolved<Key>

where Res: QueryResult,

Perform a query using the collection’s indexes, returning the keys of the items.

pub fn query_with_keys<Res>( &self, f: impl FnOnce(&Ix) -> Res, ) -> Res::Resolved<(Key, &In)>

where Res: QueryResult,

Perform a query using the collection’s indexes, returning both the keys and the items.

pub fn delete<Res>(&mut self, f: impl FnOnce(&Ix) -> Res) -> usize

where Res: QueryResult,

Delete all items matching the query.

pub fn update<Res, F>( &mut self, f: impl FnOnce(&Ix) -> Res, update_fn: impl Fn(&In) -> In, ) -> Res::Resolved<()>

where Res: QueryResultDistinct,

Update all items matching the query with the provided function.

pub fn take<Res>(&mut self, f: impl FnOnce(&Ix) -> Res) -> Res::Resolved<In>

where Res: QueryResultDistinct,

Remove and return all items matching the query.

pub fn len(&self) -> usize

Number of items in the collection.

pub fn is_empty(&self) -> bool

Trait Implementations

impl<In: Clone, Ix: Clone, S: Clone> Clone for Collection<In, Ix, S>

fn clone(&self) -> Collection<In, Ix, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<In, Ix, S> ShallowClone for Collection<In, Ix, S>

where In: Clone, Ix: ShallowClone, S: ShallowClone,

fn shallow_clone(&self) -> Self