Struct defaultmap::DefaultBTreeMap

pub struct DefaultBTreeMap<K: Eq + Hash + Ord, V: Clone> { /* fields omitted */ }

A BTreeMap that returns a default when keys are accessed that are not present.

Implementations

impl<K: Eq + Hash + Ord, V: Clone> DefaultBTreeMap<K, V>

pub fn new(default: V) -> DefaultBTreeMap<K, V>

Creates an empty DefaultHashmap with default as the default for missing keys. When the provided default is equivalent to V::default() it is preferred to use DefaultBTreeMap::default() instead.

pub fn new_with_map(default: V, map: BTreeMap<K, V>) -> DefaultBTreeMap<K, V>

Creates a DefaultBTreeMap based on a default and an already existing BTreeMap. If V::default() is the supplied default, usage of the from() constructor or the into() method on the original BTreeMap is preferred.

pub fn set_default(&mut self, new_default: V)

Changes the default value permanently or until set_default() is called again.

pub fn get<Q: ?Sized, QB: Borrow<Q>>(&self, key: QB) -> &V where
    K: Borrow<Q>,
    Q: Hash + Eq + Ord, 

Returns a reference to the value stored for the provided key. If the key is not in the DefaultBTreeMap a reference to the default value is returned. Usually the map[key] method of retrieving keys is prefered over using get directly. This method accepts both references and owned values as the key.

pub fn get_mut(&mut self, key: K) -> &mut V

Returns a mutable reference to the value stored for the provided key. If there is no value stored for the key the default value is first inserted for this key before returning the reference. Usually the map[key] = new_val is prefered over using get_mut directly. This method only accepts owned values as the key.

impl<K: Eq + Hash + Ord, V: Clone> DefaultBTreeMap<K, V>

These methods simply forward to the underlying BTreeMap, see that documentation for the usage of these methods.

pub fn keys(&self) -> Keys<'_, K, V>

pub fn values(&self) -> Values<'_, K, V>

pub fn values_mut(&mut self) -> ValuesMut<'_, K, V>

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

pub fn iter_mut(&mut self) -> IterMut<'_, K, V>

pub fn entry(&mut self, key: K) -> Entry<'_, K, V>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn clear(&mut self)

pub fn insert(&mut self, k: K, v: V) -> Option<V>

pub fn contains_key<Q: ?Sized>(&self, k: &Q) -> bool where
    K: Borrow<Q>,
    Q: Hash + Eq + Ord, 

pub fn remove<Q: ?Sized>(&mut self, k: &Q) -> Option<V> where
    K: Borrow<Q>,
    Q: Hash + Eq + Ord, 

Trait Implementations

impl<K: Clone + Eq + Hash + Ord, V: Clone> Clone for DefaultBTreeMap<K, V>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug + Eq + Hash + Ord, V: Debug + Clone> Debug for DefaultBTreeMap<K, V>

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

Formats the value using the given formatter.

impl<K: Eq + Hash + Ord, V: Default + Clone> Default for DefaultBTreeMap<K, V>

fn default() -> DefaultBTreeMap<K, V>

The default() constructor creates an empty DefaultBTreeMap with the default of V as the default for missing keys. This is desired default for most use cases, if your case requires a different default you should use the new() constructor.

impl<K: Eq + Hash + Ord, V: Eq + Clone> Eq for DefaultBTreeMap<K, V>

impl<K: Eq + Hash + Ord, V: Default + Clone> From<BTreeMap<K, V>> for DefaultBTreeMap<K, V>

fn from(map: BTreeMap<K, V>) -> DefaultBTreeMap<K, V>

If you already have a BTreeMap that you would like to convert to a DefaultBTreeMap you can use the into() method on the BTreeMap or the from() constructor of DefaultBTreeMap. The default value for missing keys will be V::default(), if this is not desired DefaultBTreeMap::new_with_map() should be used.

impl<K: Eq + Hash + Ord, V: Default + Clone> FromIterator<(K, V)> for DefaultBTreeMap<K, V>

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

Creates a value from an iterator.

impl<'a, K: Eq + Hash + Ord, KB: Borrow<K>, V: Clone> Index<KB> for DefaultBTreeMap<K, V>

Implements the Index trait so you can do map[key]. Nonmutable indexing can be done both by passing a reference or an owned value as the key.

type Output = V

The returned type after indexing.

fn index(&self, index: KB) -> &V

Performs the indexing (container[index]) operation.

impl<K: Eq + Hash + Ord, V: Clone> IndexMut<K> for DefaultBTreeMap<K, V>

Implements the IndexMut trait so you can do map[key] = val. Mutably indexing can only be done when passing an owned value as the key.

fn index_mut(&mut self, index: K) -> &mut V

Performs the mutable indexing (container[index]) operation.

impl<K: Eq + Hash + Ord, V: Clone> Into<BTreeMap<K, V>> for DefaultBTreeMap<K, V>

fn into(self) -> BTreeMap<K, V>

The into method can be used to convert a DefaultBTreeMap back into a BTreeMap.

impl<K: PartialEq + Eq + Hash + Ord, V: PartialEq + Clone> PartialEq<DefaultBTreeMap<K, V>> for DefaultBTreeMap<K, V>

fn eq(&self, other: &DefaultBTreeMap<K, V>) -> bool

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

fn ne(&self, other: &DefaultBTreeMap<K, V>) -> bool

This method tests for !=.

impl<K: Eq + Hash + Ord, V: Clone> StructuralEq for DefaultBTreeMap<K, V>

impl<K: Eq + Hash + Ord, V: Clone> StructuralPartialEq for DefaultBTreeMap<K, V>