Struct Map 

pub struct Map<K, V> { /* private fields */ }

An ordered, deduplicated collection of key-value pairs.

Implementations

impl<K: Ord, V> Map<K, V>

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

Creates a new Map from an iterator, removing duplicate keys.

Unlike FromIterator and From, this method tolerates duplicate keys by silently discarding them (keeping the first occurrence).

impl<K, V> Map<K, V>

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(&self, index: usize) -> Option<&K>

Returns a key by index, if it exists.

pub fn position(&self, key: &K) -> Option<usize>

where K: Ord,

Returns the position of the provided key, if it exists.

pub const fn keys(&self) -> &Set<K>

Returns the ordered keys as a Set reference.

pub fn into_keys(self) -> Set<K>

Consumes the map and returns the ordered keys.

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

Returns the associated value at index, if it exists.

pub fn get_value(&self, key: &K) -> Option<&V>

where K: Ord,

Returns the associated value for key, if it exists.

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

where K: Ord,

Returns a mutable reference to the associated value for key, if it exists.

pub fn values(&self) -> &[V]

Returns the associated values.

pub fn values_mut(&mut self) -> &mut [V]

Returns a mutable reference to the associated values

pub fn truncate(&mut self, len: usize)

Truncates the map to at most len entries.

pub fn iter_pairs(&self) -> impl Iterator<Item = (&K, &V)>

Returns a zipped iterator over keys and values.

pub fn iter(&self) -> Iter<'_, K>

Returns an iterator over the ordered keys.

Methods from Deref<Target = Set<K>>

pub fn len(&self) -> usize

Returns the size of the ordered collection.

pub fn is_empty(&self) -> bool

Returns true if the collection is empty.

pub fn get(&self, index: usize) -> Option<&T>

Returns an item by index, if it exists.

pub fn position(&self, item: &T) -> Option<usize>

where T: Ord,

Returns the position of a given item in the collection, if it exists.

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the items in the collection.

Trait Implementations

impl<K, V> AsRef<[K]> for Map<K, V>

fn as_ref(&self) -> &[K]

Converts this type into a shared reference of the (usually inferred) input type.

impl<K, V> AsRef<Set<K>> for Map<K, V>

fn as_ref(&self) -> &Set<K>

Converts this type into a shared reference of the (usually inferred) input type.

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<K, V> Default for Map<K, V>

fn default() -> Self

Returns the “default value” for a type.

impl<K, V> Deref for Map<K, V>

type Target = Set<K>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<K: Display, V: Display> Display for Map<K, V>

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

Formats the value using the given formatter.

impl<K: EncodeSize, V: EncodeSize> EncodeSize for Map<K, V>

fn encode_size(&self) -> usize

Returns the encoded size of this value (in bytes).

impl<K, V> From<Map<K, V>> for Vec<(K, V)>

fn from(wrapped: Map<K, V>) -> Self

Converts to this type from the input type.

impl<K: Hash, V: Hash> Hash for Map<K, V>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

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

The type of the elements being iterated over.

type IntoIter = Zip<Iter<'a, K>, Iter<'a, V>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V> IntoIterator for Map<K, V>

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = MapIntoIter<K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K: PartialEq, V: PartialEq> PartialEq for Map<K, V>

fn eq(&self, other: &Map<K, 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<K: Read + Ord, V: Read> Read for Map<K, V>

type Cfg = (RangeCfg<usize>, <K as Read>::Cfg, <V as Read>::Cfg)

The Cfg type parameter allows passing configuration during the read process. This is crucial for safely decoding untrusted data, for example, by providing size limits for collections or strings.

fn read_cfg(buf: &mut impl Buf, cfg: &Self::Cfg) -> Result<Self, Error>

Reads a value from the buffer using the provided configuration cfg.

impl<K: Ord + Clone, V: Clone> TryFrom<&[(K, V)]> for Map<K, V>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(items: &[(K, V)]) -> Result<Self, Self::Error>

Performs the conversion.

impl<K: Ord + Clone, V: Clone, const N: usize> TryFrom<&[(K, V); N]> for Map<K, V>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(items: &[(K, V); N]) -> Result<Self, Self::Error>

Performs the conversion.

impl<K: Ord, V, const N: usize> TryFrom<[(K, V); N]> for Map<K, V>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(items: [(K, V); N]) -> Result<Self, Self::Error>

Performs the conversion.

impl<K, V: Eq + Hash> TryFrom<Map<K, V>> for BiMap<K, V>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(map: Map<K, V>) -> Result<Self, Self::Error>

Performs the conversion.

impl<K: Ord, V> TryFrom<Vec<(K, V)>> for Map<K, V>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(items: Vec<(K, V)>) -> Result<Self, Self::Error>

Performs the conversion.

impl<K: Ord, V> TryFromIterator<(K, V)> for Map<K, V>

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

Attempts to create a Map from an iterator.

Returns an error if there are duplicate keys.

type Error = Error

The error type returned when construction fails.

impl<K: Write, V: Write> Write for Map<K, V>

fn write(&self, buf: &mut impl BufMut)

Writes the binary representation of self to the provided buffer buf.

impl<K: Eq, V: Eq> Eq for Map<K, V>

impl<K, V> StructuralPartialEq for Map<K, V>