Struct OrderedMap

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

An order-preserving map which can be constructed at compile time.

“Order-preserving” means iteration order is guaranteed to match the definition order.

Implementations

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

pub const fn new() -> Self

Create an empty map.

pub const fn len(&self) -> usize

Returns the number of entries in the map.

pub const fn is_empty(&self) -> bool

Returns true if the map is empty.

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

where K: PhfKeyProxy<T>,

Returns a reference to the value that key maps to.

Examples found in repository

examples/custom.rs (line 19)

fn main() {
    BY_VAL.get(&12).unwrap();
    BY_REF.get(&10).unwrap();
}

examples/simple.rs (line 20)

fn main() {
    let v = KEYWORDS.get("loop");

    let Some(Keyword::Loop) = v else {
        panic!("failed")
    };
}

examples/nested.rs (line 29)

fn main() {
    let v = KEYWORDS.get(&2).unwrap().get("break");

    let Some(Keyword::Break) = v else {
        panic!("failed")
    };
}

examples/uncased.rs (line 9)

fn main() {
    assert_eq!(MAP.get("foo").cloned(), Some(0));
    assert_eq!(MAP.get("bAR").cloned(), Some(1));
    assert_eq!(MAP.get(&"bAR".to_owned()).cloned(), Some(1));
}

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

where K: PhfKeyProxy<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 K: PhfKeyProxy<T>,

Determines if key is in the OrderedMap.

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

where K: PhfKeyProxy<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 K: PhfKeyProxy<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<K, V> Default for OrderedMap<K, V>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, K, V, T: ?Sized> Index<&'a T> for OrderedMap<K, V>

where K: PhfKeyProxy<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 = Map<Iter<'a, (K, V)>, fn(&(K, V)) -> (&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: PartialEq, V: PartialEq> PartialEq for OrderedMap<K, V>

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: Eq, V: Eq> Eq for OrderedMap<K, V>