Struct SlugMap 

pub struct SlugMap<V> { /* private fields */ }

An immutable HashMap that uses Slugs as keys and allows efficiently searching for matching entries by string reference.

Implementations

impl<V> SlugMap<V>

pub fn empty() -> Self

Creates an empty SlugMap.

pub fn new(input: HashMap<Slug, V>) -> Self

Consumes and transforms the given HashMap with Slug keys into a SlugMap.

pub fn from(input: HashMap<String, V>) -> Self

Consumes and transforms the given HashMap with String keys into a SlugMap.

If any two keys in the input resolve to the same Slug — only one of two values is retained.

pub fn zip<F>(input: HashMap<String, V>, zipper: F) -> Self

where F: FnMut(V, V) -> V,

Consumes and transforms the given HashMap with String keys into a SlugMap.

If any two keys in the input resolve to the same Slug — the two values are consumed and merged using the provided zipper function.

impl<V> SlugMap<V>

pub fn contains_key(&self, key: impl AsRef<str>) -> bool

Returns true if the map contains a value for the specified key, comparing the keys as Slugs.

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

Returns a reference to the value corresponding to the key, comparing the keys as Slugs.

If the map contains a value for the Slug key "somekey", then calling this method with anything that compares equally to that slug (e.g., "SomeKey" or "__some_key") will find and return that value.

pub fn map<NV, F>(self, mapper: F) -> SlugMap<NV>

where F: FnMut(&Slug, V) -> NV,

Maps the values of this SlugMap using the given mapper function. Leaves the keys unchanged.

Trait Implementations

impl<V: Clone> Clone for SlugMap<V>

fn clone(&self) -> SlugMap<V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: Debug> Debug for SlugMap<V>

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

Formats the value using the given formatter.

impl<V> Default for SlugMap<V>

fn default() -> Self

Returns the “default value” for a type.

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

where S: Into<Slug>,

fn from(value: [(S, V); N]) -> Self

Converts to this type from the input type.

impl<S, V> FromIterator<(S, V)> for SlugMap<V>

where S: Into<Slug>,

fn from_iter<T: IntoIterator<Item = (S, V)>>(iter: T) -> Self

Creates a value from an iterator.

impl<V: PartialEq> PartialEq for SlugMap<V>

fn eq(&self, other: &SlugMap<V>) -> 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<V: Eq> Eq for SlugMap<V>

impl<V> StructuralPartialEq for SlugMap<V>