Struct mortal::sequence::SequenceMap

pub struct SequenceMap<K, V> { /* fields omitted */ }

Contains a set of string sequences, mapped to a value.

Methods

impl<K: AsRef<str>, V> SequenceMap<K, V>

pub fn new() -> SequenceMap<K, V>

Creates an empty SequenceMap.

pub fn with_capacity(n: usize) -> SequenceMap<K, V>

Creates an empty SequenceMap with allocated capacity for n elements.

pub fn sequences(&self) -> &[(K, V)]

Returns a slice of all contained sequences, sorted by key.

pub fn sequences_mut(&mut self) -> &mut [(K, V)]

Returns a mutable slice of all contained sequences, sorted by key.

Note

Elements must remain sorted by key for the proper functioning of SequenceMap operations. If keys are modified, the caller must ensure that the slice is sorted.

pub fn entry(&mut self, key: K) -> Entry<K, V>

Returns an Entry for the given key.

This API matches the entry API for the standard HashMap collection.

pub fn find(&self, key: &str) -> FindResult<&V>

Performs a search for a partial or complete sequence match.

pub fn get(&self, key: &str) -> Option<&V>

Returns the corresponding value for the given sequence.

pub fn get_mut(&mut self, key: &str) -> Option<&mut V>

Returns a mutable reference to the corresponding value for the given sequence.

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

Inserts a key-value pair into the map.

If the key already exists in the map, the new value will replace the old value and the old value will be returned.

pub fn remove(&mut self, key: &str) -> Option<(K, V)>

Removes a key-value pair from the map.

Trait Implementations

impl<K: Clone, V: Clone> Clone for SequenceMap<K, V>

fn clone(&self) -> SequenceMap<K, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug, V: Debug> Debug for SequenceMap<K, V>

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

Formats the value using the given formatter.

impl<K: Default, V: Default> Default for SequenceMap<K, V>

fn default() -> SequenceMap<K, V>

Returns the "default value" for a type.

impl<K: AsRef<str>, V> From<Vec<(K, V)>> for SequenceMap<K, V>

fn from(sequences: Vec<(K, V)>) -> SequenceMap<K, V>

Creates a SequenceMap from a Vec of key-value pairs.

The input Vec will be sorted and deduplicated.

If two elements exist with the same key, the first element is used.

impl<K: AsRef<str>, V> FromIterator<(K, V)> for SequenceMap<K, V>

fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self

Creates a SequenceMap from an iterator of key-value pairs.

If two elements exist with the same key, the last element is used.