Struct EventIdMap 

pub struct EventIdMap<E, V>(/* private fields */)
where
    E: Borrow<EventId>;

Available on crate feature state-res only.

A map of event IDs to a type V.

Implementations

impl<E, V> EventIdMap<E, V>

where E: Borrow<EventId>,

pub fn new() -> EventIdMap<E, V>

Create an empty EventIdMap.

pub fn with_capacity(capacity: usize) -> EventIdMap<E, V>

Create an empty EventIdMap with the given capacity.

pub fn clear(&mut self)

Clears the map, removing all key-value pairs.

pub fn len(&self) -> usize

Returns the number of elements in the map.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

pub fn iter(&self) -> EventIdMapIter<'_, E, V>

Gets an iterator over the entries of the map.

pub fn keys(&self) -> EventIdMapKeys<'_, E, V>

Gets an iterator over the keys of the map.

pub fn into_keys(self) -> EventIdMapIntoKeys<E, V>

Gets an iterator over the keys of the map.

pub fn values(&self) -> EventIdMapValues<'_, E, V>

Gets an iterator over the values of the map.

pub fn into_values(self) -> EventIdMapIntoValues<E, V>

Gets an iterator over the values of the map.

impl<E, V> EventIdMap<E, V>

where E: Borrow<EventId> + Eq + Hash,

pub fn contains_event_id(&self, event_id: &EventId) -> bool

Returns true if the map contains a value for the specified event ID.

pub fn get(&self, event_id: &EventId) -> Option<&V>

Returns a reference to the value corresponding to given event ID.

pub fn get_mut(&mut self, event_id: &EventId) -> Option<&mut V>

Returns a mutable reference to the value corresponding to given event ID.

pub fn get_key_value(&self, event_id: &EventId) -> Option<(&E, &V)>

Returns the key-value pair corresponding to the supplied event ID.

pub fn entry(&mut self, event_id: E) -> EventIdMapEntry<'_, E, V>

Gets the given event ID’s corresponding entry in the map for in-place manipulation.

pub fn insert(&mut self, event_id: E, value: V) -> Option<V>

Inserts a key-value pair into the map.

If the map did not have this event ID present, None is returned.

If the map did have this event ID present, the value is updated, and the old value is returned.

pub fn remove(&mut self, event_id: &EventId) -> Option<V>

Removes an event ID from the map, returning the value at the event ID if the event ID was previously in the map.

pub fn remove_entry(&mut self, event_id: &EventId) -> Option<(E, V)>

Removes an event ID from the map, returning the stored event ID and value if the event ID was previously in the map.

Trait Implementations

impl<E, V> Clone for EventIdMap<E, V>

where E: Clone + Borrow<EventId>, V: Clone,

fn clone(&self) -> EventIdMap<E, V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E, V> Debug for EventIdMap<E, V>

where E: Debug + Borrow<EventId>, V: Debug,

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

Formats the value using the given formatter.

impl<E, V> Default for EventIdMap<E, V>

where E: Borrow<EventId>,

fn default() -> EventIdMap<E, V>

Returns the “default value” for a type.

impl<E, V> Extend<(E, V)> for EventIdMap<E, V>

where E: Borrow<EventId> + Hash + Eq,

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = (E, V)>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<E, V, const N: usize> From<[(E, V); N]> for EventIdMap<E, V>

where E: Borrow<EventId> + Hash + Eq,

fn from(value: [(E, V); N]) -> EventIdMap<E, V>

Converts to this type from the input type.

impl<E, V> FromIterator<(E, V)> for EventIdMap<E, V>

where E: Borrow<EventId> + Hash + Eq,

fn from_iter<T>(iter: T) -> EventIdMap<E, V>

where T: IntoIterator<Item = (E, V)>,

Creates a value from an iterator.

impl<E, V> Index<&EventId> for EventIdMap<E, V>

where E: Borrow<EventId> + Hash + Eq,

type Output = V

The returned type after indexing.

fn index( &self, event_id: &EventId, ) -> &<EventIdMap<E, V> as Index<&EventId>>::Output

Performs the indexing (container[index]) operation.

impl<'a, E, V> IntoIterator for &'a EventIdMap<E, V>

where E: Borrow<EventId>,

type Item = (&'a E, &'a V)

The type of the elements being iterated over.

type IntoIter = EventIdMapIter<'a, E, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a EventIdMap<E, V> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<E, V> IntoIterator for EventIdMap<E, V>

where E: Borrow<EventId>,

type Item = (E, V)

The type of the elements being iterated over.

type IntoIter = EventIdMapIntoIter<E, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <EventIdMap<E, V> as IntoIterator>::IntoIter

Creates an iterator from a value.