Struct toolshed::map::Map

pub struct Map<'arena, K, V>where
    K: 'arena,
    V: 'arena + Copy,{ /* private fields */ }

A map of keys K to values V. The map is built as a pseudo-random binary tree with hashes of keys used for balancing the tree nodes.

All the nodes of the map are also linked to allow iteration in insertion order.

Implementations

impl<'arena, K, V> Map<'arena, K, V>where
    K: 'arena,
    V: 'arena + Copy,

pub fn new() -> Self

Create a new, empty Map.

pub fn iter(&self) -> MapIter<'arena, K, V>

Get an iterator over key value pairs.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

pub fn clear(&self)

Clears the map.

impl<'arena, K, V> Map<'arena, K, V>where
    K: 'arena + Eq + Hash + Copy,
    V: 'arena + Copy,

pub fn insert(&self, arena: &'arena Arena, key: K, value: V) -> Option<V>

Inserts a key-value pair into the map. If the key was previously set, old value is returned.

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

Returns the value corresponding to the key.

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

Returns the value corresponding to the key.

pub fn contains_key(&self, key: K) -> bool

Returns true if the map contains a value for the specified key.

Trait Implementations

impl<'arena, K: Clone, V: Clone> Clone for Map<'arena, K, V>where
    K: 'arena,
    V: 'arena + Copy,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'arena, K, V> Debug for Map<'arena, K, V>where
    K: Debug,
    V: Debug + Copy,

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

Formats the value using the given formatter.

impl<'arena, K, V> Default for Map<'arena, K, V>where
    K: 'arena,
    V: 'arena + Copy,

fn default() -> Self

Returns the “default value” for a type.

impl<'arena, K, V> From<BloomMap<'arena, K, V>> for Map<'arena, K, V>where
    K: 'arena + Eq + Hash + Copy + AsRef<[u8]>,
    V: 'arena + Copy,

fn from(bloom_map: BloomMap<'arena, K, V>) -> Map<'arena, K, V>

Converts to this type from the input type.

impl<'arena, K, V> From<Map<'arena, K, V>> for BloomMap<'arena, K, V>where
    K: 'arena + Eq + Hash + Copy + AsRef<[u8]>,
    V: 'arena + Copy,

fn from(map: Map<'arena, K, V>) -> BloomMap<'arena, K, V>

Converts to this type from the input type.

impl<'arena, K, V> IntoIterator for Map<'arena, K, V>where
    K: 'arena,
    V: 'arena + Copy,

type Item = (&'arena K, V)

The type of the elements being iterated over.

type IntoIter = MapIter<'arena, K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, 'b, KA, VA, KB, VB> PartialEq<Map<'b, KB, VB>> for Map<'a, KA, VA>where
    (&'a KA, VA): PartialEq<(&'b KB, VB)>,
    VA: Copy,
    VB: Copy,

fn eq(&self, other: &Map<'b, KB, VB>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'arena, K: Copy, V: Copy> Copy for Map<'arena, K, V>where
    K: 'arena,
    V: 'arena + Copy,