Struct phf::OrderedMap

pub struct OrderedMap<K: 'static, V: 'static> { /* fields omitted */ }

An order-preserving immutable map constructed at compile time.

Unlike a Map, iteration order is guaranteed to match the definition order.

Note

The fields of this struct are public so that they may be initialized by the phf_ordered_map! macro and code generation. They are subject to change at any time and should never be accessed directly.

Methods

impl<K, V> OrderedMap<K, V>

pub fn len(&self) -> usize

Returns the number of entries in the Map.

pub fn is_empty(&self) -> bool

Returns true if the Map is empty.

pub fn get<T: ?Sized>(&self, key: &T) -> Option<&V> where
    T: Eq + PhfHash,
    K: Borrow<T>, 

Returns a reference to the value that key maps to.

pub fn get_key<T: ?Sized>(&self, key: &T) -> Option<&K> where
    T: Eq + PhfHash,
    K: Borrow<T>, 

Returns a reference to the map's internal static instance of the given key.

This can be useful for interning schemes.

pub fn contains_key<T: ?Sized>(&self, key: &T) -> bool where
    T: Eq + PhfHash,
    K: Borrow<T>, 

Determines if key is in the Map.

pub fn get_index<T: ?Sized>(&self, key: &T) -> Option<usize> where
    T: Eq + PhfHash,
    K: Borrow<T>, 

Returns the index of the key within the list used to initialize the ordered map.

pub fn index(&self, index: usize) -> Option<(&K, &V)>

Returns references to both the key and values at an index within the list used to initialize the ordered map. See .get_index(key).

pub fn get_entry<T: ?Sized>(&self, key: &T) -> Option<(&K, &V)> where
    T: Eq + PhfHash,
    K: Borrow<T>, 

Like get, but returns both the key and the value.

Important traits for Entries<'a, K, V>

impl<'a, K, V> Iterator for Entries<'a, K, V> type Item = (&'a K, &'a V);

pub fn entries<'a>(&'a self) -> Entries<'a, K, V>

Returns an iterator over the key/value pairs in the map.

Entries are returned in the same order in which they were defined.

Important traits for Keys<'a, K, V>

impl<'a, K, V> Iterator for Keys<'a, K, V> type Item = &'a K;

pub fn keys<'a>(&'a self) -> Keys<'a, K, V>

Returns an iterator over the keys in the map.

Keys are returned in the same order in which they were defined.

Important traits for Values<'a, K, V>

impl<'a, K, V> Iterator for Values<'a, K, V> type Item = &'a V;

pub fn values<'a>(&'a self) -> Values<'a, K, V>

Returns an iterator over the values in the map.

Values are returned in the same order in which they were defined.

Trait Implementations

impl<K, V> Debug for OrderedMap<K, V> where
    K: Debug,
    V: Debug, 

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

Formats the value using the given formatter.

impl<'a, K, V, T: ?Sized> Index<&'a T> for OrderedMap<K, V> where
    T: Eq + PhfHash,
    K: Borrow<T>, 

type Output = V

The returned type after indexing.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn index(&self, k: &'a T) -> &V

Performs the indexing (container[index]) operation.

impl<'a, K, V> IntoIterator for &'a OrderedMap<K, V>

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

The type of the elements being iterated over.

type IntoIter = Entries<'a, K, V>

Which kind of iterator are we turning this into?

Important traits for Entries<'a, K, V>

impl<'a, K, V> Iterator for Entries<'a, K, V> type Item = (&'a K, &'a V);

fn into_iter(self) -> Entries<'a, K, V>

Creates an iterator from a value.