Struct BiMap 

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

An ordered, deduplicated collection of key-value pairs with unique values.

Implementations

impl<K, V> BiMap<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_key(&self, value: &V) -> Option<&K>

where V: PartialEq,

Returns the associated key for value, if it exists.

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

Returns the associated values.

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 BiMap<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 BiMap<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 BiMap<K, V>

fn clone(&self) -> BiMap<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 BiMap<K, V>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<K, V> Deref for BiMap<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 BiMap<K, V>

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

Formats the value using the given formatter.

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

fn encode_size(&self) -> usize

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

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

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

Converts to this type from the input type.

impl<K: Hash, V: Hash> Hash for BiMap<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 BiMap<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 BiMap<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 BiMap<K, V>

fn eq(&self, other: &BiMap<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: Eq + Hash + Read> Read for BiMap<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 + Eq + Hash> TryFrom<&[(K, V)]> for BiMap<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 + Eq + Hash, const N: usize> TryFrom<&[(K, V); N]> for BiMap<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: Eq + Hash, const N: usize> TryFrom<[(K, V); N]> for BiMap<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: Eq + Hash> TryFrom<Vec<(K, V)>> for BiMap<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: Eq + Hash> TryFromIterator<(K, V)> for BiMap<K, V>

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

Attempts to create a BiMap from an iterator of key-value pairs.

Returns an error if any key or value is duplicated.

type Error = Error

The error type returned when construction fails.

impl<K: Write, V: Write> Write for BiMap<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 BiMap<K, V>

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