Struct nonempty_collections::map::NEMap
source · pub struct NEMap<K, V, S = RandomState> {
pub head_key: K,
pub head_val: V,
pub tail: HashMap<K, V, S>,
}
Expand description
A non-empty, growable HashMap
.
use nonempty_collections::nem;
let m = nem!["elves" => 3000, "orcs" => 10000];
assert_eq!(2, m.len().get());
Fields§
§head_key: K
The key of the ever-present element of the non-empty HashMap
.
head_val: V
The value of the ever-present element of the non-empty HashMap
.
tail: HashMap<K, V, S>
The remaining key-value pairs, perhaps empty.
Implementations§
source§impl<K, V, S> NEMap<K, V, S>
impl<K, V, S> NEMap<K, V, S>
sourcepub fn capacity(&self) -> usize
pub fn capacity(&self) -> usize
Returns the number of elements the map can hold without reallocating.
sourcepub fn iter(&self) -> Iter<'_, K, V>
pub fn iter(&self) -> Iter<'_, K, V>
An iterator visiting all elements in arbitrary order. The iterator
element type is (&'a K, &'a V)
.
sourcepub fn iter_mut(&mut self) -> IterMut<'_, K, V>
pub fn iter_mut(&mut self) -> IterMut<'_, K, V>
An iterator visiting all elements in arbitrary order. The iterator
element type is (&'a K, &'a mut V)
.
§Panics
If you manually advance this iterator until empty and then call first
,
you’re in for a surprise.
sourcepub fn keys(&self) -> Keys<'_, K, V>
pub fn keys(&self) -> Keys<'_, K, V>
An iterator visiting all keys in arbitrary order. The iterator element
type is &'a K
.
use nonempty_collections::*;
let m = nem!["Valmar" => "Vanyar", "Tirion" => "Noldor", "Alqualondë" => "Teleri"];
let mut v: NEVec<_> = m.keys().collect();
v.sort();
assert_eq!(nev![&"Alqualondë", &"Tirion", &"Valmar"], v);
sourcepub fn len(&self) -> NonZeroUsize
pub fn len(&self) -> NonZeroUsize
Returns the number of elements in the map. Always 1 or more.
use nonempty_collections::nem;
let m = nem!["a" => 1, "b" => 2];
assert_eq!(2, m.len().get());
sourcepub const fn is_empty(&self) -> bool
👎Deprecated since 0.1.0: A NEMap is never empty.
pub const fn is_empty(&self) -> bool
A NEMap
is never empty.
sourcepub fn values(&self) -> Values<'_, K, V>
pub fn values(&self) -> Values<'_, K, V>
An iterator visiting all values in arbitrary order. The iterator element
type is &'a V
.
use nonempty_collections::*;
let m = nem!["Valmar" => "Vanyar", "Tirion" => "Noldor", "Alqualondë" => "Teleri"];
let mut v: NEVec<_> = m.values().collect();
v.sort();
assert_eq!(nev![&"Noldor", &"Teleri", &"Vanyar"], v);
source§impl<K, V, S> NEMap<K, V, S>
impl<K, V, S> NEMap<K, V, S>
sourcepub fn contains_key<Q>(&self, k: &Q) -> bool
pub fn contains_key<Q>(&self, k: &Q) -> bool
Returns true if the map contains a value.
use nonempty_collections::nem;
let m = nem!["Jack" => 8];
assert!(m.contains_key("Jack"));
assert!(!m.contains_key("Colin"));
sourcepub fn get<Q>(&self, k: &Q) -> Option<&V>
pub fn get<Q>(&self, k: &Q) -> Option<&V>
Returns a reference to the value corresponding to the key.
The key may be any borrowed form of the map’s value type, but Hash
and
Eq
on the borrowed form must match those for the key type.
use nonempty_collections::nem;
let m = nem!["silmarils" => 3];
assert_eq!(Some(&3), m.get("silmarils"));
assert_eq!(None, m.get("arkenstone"));
sourcepub fn get_key_value<Q>(&self, k: &Q) -> Option<(&K, &V)>
pub fn get_key_value<Q>(&self, k: &Q) -> Option<(&K, &V)>
Returns the key-value pair corresponding to the key.
The key may be any borrowed form of the map’s value type, but Hash
and
Eq
on the borrowed form must match those for the key type.
use nonempty_collections::nem;
let m = nem!["silmarils" => 3];
assert_eq!(Some((&"silmarils", &3)), m.get_key_value("silmarils"));
assert_eq!(None, m.get_key_value("arkenstone"));
sourcepub fn get_mut<Q>(&mut self, k: &Q) -> Option<&mut V>
pub fn get_mut<Q>(&mut self, k: &Q) -> Option<&mut V>
Returns a reference to the value corresponding to the key.
The key may be any borrowed form of the map’s value type, but Hash
and
Eq
on the borrowed form must match those for the key type.
use nonempty_collections::nem;
let mut m = nem!["silmarils" => 3];
let mut v = m.get_mut("silmarils").unwrap();
// And thus it came to pass that the Silmarils found their long homes:
// one in the airs of heaven, and one in the fires of the heart of the
// world, and one in the deep waters.
*v -= 3;
assert_eq!(Some(&0), m.get("silmarils"));
sourcepub fn insert(&mut self, k: K, v: V) -> Option<V>
pub fn insert(&mut self, k: K, v: V) -> Option<V>
Insert a key-value pair into the map.
If the map did not have this present, None
is returned.
If the map did have this key present, the value is updated, and the old
value is returned. The key is not updated, though; this matters for
types that can be ==
without being identical. See HashMap::insert
for more.
use nonempty_collections::nem;
let mut m = nem!["Vilya" => "Elrond", "Nenya" => "Galadriel"];
assert_eq!(None, m.insert("Narya", "Cirdan"));
// The Ring of Fire was given to Gandalf upon his arrival in Middle Earth.
assert_eq!(Some("Cirdan"), m.insert("Narya", "Gandalf"));
sourcepub fn shrink_to_fit(&mut self)
pub fn shrink_to_fit(&mut self)
Shrinks the capacity of the map as much as possible. It will drop down as much as possible while maintaining the internal rules and possibly leaving some space in accordance with the resize policy.
sourcepub fn with_capacity(capacity: usize, k: K, v: V) -> NEMap<K, V>
pub fn with_capacity(capacity: usize, k: K, v: V) -> NEMap<K, V>
Creates a new NEMap
with a single element and specified capacity.
sourcepub fn with_capacity_and_hasher(
capacity: usize,
hasher: S,
k: K,
v: V,
) -> NEMap<K, V, S>
pub fn with_capacity_and_hasher( capacity: usize, hasher: S, k: K, v: V, ) -> NEMap<K, V, S>
sourcepub fn with_hasher(hasher: S, k: K, v: V) -> NEMap<K, V, S>
pub fn with_hasher(hasher: S, k: K, v: V) -> NEMap<K, V, S>
See HashMap::with_hasher
.
Trait Implementations§
source§impl<'de, K, V, S> Deserialize<'de> for NEMap<K, V, S>
impl<'de, K, V, S> Deserialize<'de> for NEMap<K, V, S>
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
source§impl<K, V, S> FromNonEmptyIterator<(K, V)> for NEMap<K, V, S>
impl<K, V, S> FromNonEmptyIterator<(K, V)> for NEMap<K, V, S>
use nonempty_collections::*;
let v = nev![('a', 1), ('b', 2), ('c', 3), ('a', 4)];
let m0: NEMap<_, _> = v.into_nonempty_iter().collect();
let m1: NEMap<_, _> = nem!['a' => 1, 'b' => 2, 'c' => 3];
assert_eq!(m0, m1);
source§fn from_nonempty_iter<I>(iter: I) -> Selfwhere
I: IntoNonEmptyIterator<Item = (K, V)>,
fn from_nonempty_iter<I>(iter: I) -> Selfwhere
I: IntoNonEmptyIterator<Item = (K, V)>,
NonEmptyIterator
.source§impl<K, V, S> IntoNonEmptyIterator for NEMap<K, V, S>
impl<K, V, S> IntoNonEmptyIterator for NEMap<K, V, S>
§type IntoIter = Chain<Once<(K, V)>, IntoIter<K, V>>
type IntoIter = Chain<Once<(K, V)>, IntoIter<K, V>>
NonEmptyIterator
are we turning this into?source§fn into_nonempty_iter(self) -> Self::IntoIter
fn into_nonempty_iter(self) -> Self::IntoIter
NonEmptyIterator
from a value.source§impl<K, V, S> PartialEq for NEMap<K, V, S>
impl<K, V, S> PartialEq for NEMap<K, V, S>
impl<K, V, S> Eq for NEMap<K, V, S>
Auto Trait Implementations§
impl<K, V, S> Freeze for NEMap<K, V, S>
impl<K, V, S> RefUnwindSafe for NEMap<K, V, S>
impl<K, V, S> Send for NEMap<K, V, S>
impl<K, V, S> Sync for NEMap<K, V, S>
impl<K, V, S> Unpin for NEMap<K, V, S>
impl<K, V, S> UnwindSafe for NEMap<K, V, S>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.