Struct OrderedMap 

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

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.

Implementations

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

pub const fn len(&self) -> usize

Returns the number of entries in the OrderedMap.

pub const fn is_empty(&self) -> bool

Returns true if the OrderedMap is empty.

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

where T: Eq + PhfHash + ?Sized, K: PhfBorrow<T>,

Returns a reference to the value that key maps to.

pub fn get_key<T>(&self, key: &T) -> Option<&K>

where T: Eq + PhfHash + ?Sized, K: PhfBorrow<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>(&self, key: &T) -> bool

where T: Eq + PhfHash + ?Sized, K: PhfBorrow<T>,

Determines if key is in the OrderedMap.

pub fn get_index<T>(&self, key: &T) -> Option<usize>

where T: Eq + PhfHash + ?Sized, K: PhfBorrow<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>(&self, key: &T) -> Option<(&K, &V)>

where T: Eq + PhfHash + ?Sized, K: PhfBorrow<T>,

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

pub fn entries(&self) -> Entries<'_, 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.

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

Returns an iterator over the keys in the map.

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

pub fn values(&self) -> Values<'_, 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> Index<&'a T> for OrderedMap<K, V>

where T: Eq + PhfHash + ?Sized, K: PhfBorrow<T>,

type Output = V

The returned type after indexing.

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?

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

Creates an iterator from a value.

impl<K, V> PartialEq for OrderedMap<K, V>

where K: PartialEq, V: PartialEq,

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K, V> Eq for OrderedMap<K, V>

where K: Eq, V: Eq,

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 56 bytes