Struct Collection

pub struct Collection<In, Ix> { /* private fields */ }

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

Implementations

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

where Ix: Index<In>,

pub fn new(ix: Ix) -> Collection<In, Ix>

Create an empty collection.

pub fn get(&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 iter(&self) -> impl Iterator<Item = (&Key, &In)>

Iterate over all items in the collection.

pub fn update_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<F>(&mut self, key: Key, f: F)

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

Update the item in the collection.

pub fn adjust_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<F>(&mut self, key: Key, f: F)

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

Adjust the item in the collection, if it exists.

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

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

pub fn query(&self) -> <Ix as Index<In>>::Query<'_, In>

Query the collection using its index(es).

pub fn len(&self) -> usize

Number of items in the collection.

pub fn is_empty(&self) -> bool