Struct imbl_value::in_order_map::InOMap
source · pub struct InOMap<K, V>{ /* private fields */ }
Implementations§
source§impl<K, V> InOMap<K, V>
impl<K, V> InOMap<K, V>
pub fn get<BK>(&self, key: &BK) -> Option<&V>
pub fn get_key_value<BK>(&self, key: &BK) -> Option<(&K, &V)>
pub fn contains_key<BK>(&self, k: &BK) -> bool
pub fn is_submap_by<B, RM, F>(&self, other: RM, cmp: F) -> bool
pub fn is_proper_submap_by<B, RM, F>(&self, other: RM, cmp: F) -> bool
pub fn is_submap<RM>(&self, other: RM) -> bool
pub fn is_proper_submap<RM>(&self, other: RM) -> bool
source§impl<K, V> InOMap<K, V>
impl<K, V> InOMap<K, V>
sourcepub fn iter_mut(&mut self) -> IterMut<'_, (K, V)>
pub fn iter_mut(&mut self) -> IterMut<'_, (K, V)>
Get a mutable iterator over the values of a hash map.
Please note that the order is consistent between maps using the same hasher, but no other ordering guarantee is offered. Items will not come out in insertion order or sort order. They will, however, come out in the same order every time for the same map.
sourcepub fn get_mut<BK>(&mut self, key: &BK) -> Option<&mut V>
pub fn get_mut<BK>(&mut self, key: &BK) -> Option<&mut V>
Get a mutable reference to the value for a key from a hash map.
Time: O(n)
Examples
let mut map = inOMap!{123 => "lol"};
if let Some(value) = map.get_mut(&123) {
*value = "omg";
}
assert_eq!(
map.get(&123),
Some(&"omg")
);
sourcepub fn insert(&mut self, key: K, v: V) -> Option<V>
pub fn insert(&mut self, key: K, v: V) -> Option<V>
Insert a key/value mapping into a map.
If the map already has a mapping for the given key, the previous value is overwritten.
Time: O(n)
Examples
let mut map = inOMap!{};
map.insert(123, "123");
map.insert(456, "456");
assert_eq!(
map,
inOMap!{123 => "123", 456 => "456"}
);
sourcepub fn remove<BK>(&mut self, k: &BK) -> Option<V>
pub fn remove<BK>(&mut self, k: &BK) -> Option<V>
Remove a key/value pair from a map, if it exists, and return the removed value.
This is a copy-on-write operation, so that the parts of the set’s structure which are shared with other sets will be safely copied before mutating.
Time: O(n)
Examples
let mut map = inOMap!{123 => "123", 456 => "456"};
assert_eq!(Some("123"), map.remove(&123));
assert_eq!(Some("456"), map.remove(&456));
assert_eq!(None, map.remove(&789));
assert!(map.is_empty());
sourcepub fn remove_with_key<BK>(&mut self, k: &BK) -> Option<(K, V)>
pub fn remove_with_key<BK>(&mut self, k: &BK) -> Option<(K, V)>
Remove a key/value pair from a map, if it exists, and return the removed key and value.
Time: O(n)
Examples
let mut map = inOMap!{123 => "123", 456 => "456"};
assert_eq!(Some((123, "123")), map.remove_with_key(&123));
assert_eq!(Some((456, "456")), map.remove_with_key(&456));
assert_eq!(None, map.remove_with_key(&789));
assert!(map.is_empty());
sourcepub fn entry(&mut self, key: K) -> Entry<'_, K, V>
pub fn entry(&mut self, key: K) -> Entry<'_, K, V>
Get the Entry
for a key in the map for in-place manipulation.
Time: O(n)
sourcepub fn update(&self, k: K, v: V) -> Self
pub fn update(&self, k: K, v: V) -> Self
Construct a new hash map by inserting a key/value mapping into a map.
If the map already has a mapping for the given key, the previous value is overwritten.
Time: O(n)
Examples
let map = inOMap!{};
assert_eq!(
map.update(123, "123"),
inOMap!{123 => "123"}
);
sourcepub fn update_with<F>(&self, k: K, v: V, f: F) -> Selfwhere
F: FnOnce(V, V) -> V,
pub fn update_with<F>(&self, k: K, v: V, f: F) -> Selfwhere
F: FnOnce(V, V) -> V,
Construct a new hash map by inserting a key/value mapping into a map.
If the map already has a mapping for the given key, we call the provided function with the old value and the new value, and insert the result as the new value.
Time: O(n)
sourcepub fn update_with_key<F>(&self, k: K, v: V, f: F) -> Self
pub fn update_with_key<F>(&self, k: K, v: V, f: F) -> Self
Construct a new map by inserting a key/value mapping into a map.
If the map already has a mapping for the given key, we call the provided function with the key, the old value and the new value, and insert the result as the new value.
Time: O(n)
sourcepub fn update_lookup_with_key<F>(&self, k: K, v: V, f: F) -> (Option<V>, Self)
pub fn update_lookup_with_key<F>(&self, k: K, v: V, f: F) -> (Option<V>, Self)
Construct a new map by inserting a key/value mapping into a map, returning the old value for the key as well as the new map.
If the map already has a mapping for the given key, we call the provided function with the key, the old value and the new value, and insert the result as the new value.
Time: O(n)
sourcepub fn alter<F>(&self, f: F, k: K) -> Self
pub fn alter<F>(&self, f: F, k: K) -> Self
Update the value for a given key by calling a function with the current value and overwriting it with the function’s return value.
The function gets an Option<V>
and
returns the same, so that it can decide to delete a mapping
instead of updating the value, and decide what to do if the
key isn’t in the map.
Time: O(n)
sourcepub fn without<BK>(&self, k: &BK) -> Self
pub fn without<BK>(&self, k: &BK) -> Self
Construct a new map without the given key.
Construct a map that’s a copy of the current map, absent the
mapping for key
if it’s present.
Time: O(n)
sourcepub fn retain<F>(&mut self, f: F)
pub fn retain<F>(&mut self, f: F)
Filter out values from a map which don’t satisfy a predicate.
This is slightly more efficient than filtering using an iterator, in that it doesn’t need to rehash the retained values, but it still needs to reconstruct the entire tree structure of the map.
Time: O(n ^ 2)
Examples
let mut map = inOMap!{1 => 1, 2 => 2, 3 => 3};
map.retain(|k, v| *k > 1);
let expected = inOMap!{2 => 2, 3 => 3};
assert_eq!(expected, map);
sourcepub fn extract<BK>(&self, k: &BK) -> Option<(V, Self)>
pub fn extract<BK>(&self, k: &BK) -> Option<(V, Self)>
Remove a key/value pair from a map, if it exists, and return the removed value as well as the updated map.
Time: O(n)
sourcepub fn extract_with_key<BK>(&self, k: &BK) -> Option<(K, V, Self)>
pub fn extract_with_key<BK>(&self, k: &BK) -> Option<(K, V, Self)>
Remove a key/value pair from a map, if it exists, and return the removed key and value as well as the updated list.
Time: O(n)
sourcepub fn union(self, other: Self) -> Self
pub fn union(self, other: Self) -> Self
Construct the union of two maps, keeping the values in the current map when keys exist in both maps.
Time: O(n ^ 2)
Examples
let map1 = inOMap!{1 => 1, 3 => 3};
let map2 = inOMap!{2 => 2, 3 => 4};
let expected = inOMap!{ 2 => 2, 3 => 3, 1 => 1,};
assert_eq!(expected, map1.union(map2));
sourcepub fn union_with<F>(self, other: Self, f: F) -> Selfwhere
F: FnMut(V, V) -> V,
pub fn union_with<F>(self, other: Self, f: F) -> Selfwhere
F: FnMut(V, V) -> V,
Construct the union of two maps, using a function to decide what to do with the value when a key is in both maps.
The function is called when a value exists in both maps, and receives the value from the current map as its first argument, and the value from the other map as the second. It should return the value to be inserted in the resulting map.
Time: O(n ^ 2)
sourcepub fn union_with_key<F>(self, other: Self, f: F) -> Self
pub fn union_with_key<F>(self, other: Self, f: F) -> Self
Construct the union of two maps, using a function to decide what to do with the value when a key is in both maps.
The function is called when a value exists in both maps, and receives a reference to the key as its first argument, the value from the current map as the second argument, and the value from the other map as the third argument. It should return the value to be inserted in the resulting map.
Time: O(n ^ 2)
Examples
let map1 = inOMap!{1 => 1, 3 => 4};
let map2 = inOMap!{2 => 2, 3 => 5};
let expected = inOMap!{1 => 1, 2 => 2, 3 => 9};
assert_eq!(expected, map1.union_with_key(
map2,
|key, left, right| left + right
));
sourcepub fn unions<I>(i: I) -> Selfwhere
I: IntoIterator<Item = Self>,
pub fn unions<I>(i: I) -> Selfwhere
I: IntoIterator<Item = Self>,
Construct the union of a sequence of maps, selecting the value of the leftmost when a key appears in more than one map.
Time: O(n ^ 2)
Examples
let map1 = inOMap!{1 => 1, 3 => 3};
let map2 = inOMap!{2 => 2};
let expected = inOMap!{2 => 2, 1 => 1, 3 => 3};
assert_eq!(expected, InOMap::unions(vec![map1, map2]));
sourcepub fn unions_with<I, F>(i: I, f: F) -> Selfwhere
I: IntoIterator<Item = Self>,
F: Fn(V, V) -> V,
pub fn unions_with<I, F>(i: I, f: F) -> Selfwhere
I: IntoIterator<Item = Self>,
F: Fn(V, V) -> V,
Construct the union of a sequence of maps, using a function to decide what to do with the value when a key is in more than one map.
The function is called when a value exists in multiple maps, and receives the value from the current map as its first argument, and the value from the next map as the second. It should return the value to be inserted in the resulting map.
Time: O(n ^ 2)
sourcepub fn unions_with_key<I, F>(i: I, f: F) -> Self
pub fn unions_with_key<I, F>(i: I, f: F) -> Self
Construct the union of a sequence of maps, using a function to decide what to do with the value when a key is in more than one map.
The function is called when a value exists in multiple maps, and receives a reference to the key as its first argument, the value from the current map as the second argument, and the value from the next map as the third argument. It should return the value to be inserted in the resulting map.
Time: O(n ^ 2)
sourcepub fn difference(self, other: Self) -> Self
👎Deprecated since 2.0.1: to avoid conflicting behaviors between std and imbl, the difference
alias for symmetric_difference
will be removed.
pub fn difference(self, other: Self) -> Self
difference
alias for symmetric_difference
will be removed.Construct the symmetric difference between two maps by discarding keys which occur in both maps.
This is an alias for the
symmetric_difference
method.
Time: O(n ^ 2)
Examples
let map1 = inOMap!{1 => 1, 3 => 4};
let map2 = inOMap!{2 => 2, 3 => 5};
let expected = inOMap!{1 => 1, 2 => 2};
assert_eq!(expected, map1.difference(map2));
sourcepub fn symmetric_difference(self, other: Self) -> Self
pub fn symmetric_difference(self, other: Self) -> Self
Construct the symmetric difference between two maps by discarding keys which occur in both maps.
Time: O(n ^ 2)
Examples
let map1 = inOMap!{1 => 1, 3 => 4};
let map2 = inOMap!{2 => 2, 3 => 5};
let expected = inOMap!{1 => 1, 2 => 2};
assert_eq!(expected, map1.symmetric_difference(map2));
sourcepub fn difference_with<F>(self, other: Self, f: F) -> Self
👎Deprecated since 2.0.1: to avoid conflicting behaviors between std and imbl, the difference_with
alias for symmetric_difference_with
will be removed.
pub fn difference_with<F>(self, other: Self, f: F) -> Self
difference_with
alias for symmetric_difference_with
will be removed.Construct the symmetric difference between two maps by using a function to decide what to do if a key occurs in both.
This is an alias for the
symmetric_difference_with
method.
Time: O(n ^ 2)
sourcepub fn symmetric_difference_with<F>(self, other: Self, f: F) -> Self
pub fn symmetric_difference_with<F>(self, other: Self, f: F) -> Self
Construct the symmetric difference between two maps by using a function to decide what to do if a key occurs in both.
Time: O(n ^ 2)
sourcepub fn difference_with_key<F>(self, other: Self, f: F) -> Self
👎Deprecated since 2.0.1: to avoid conflicting behaviors between std and imbl, the difference_with_key
alias for symmetric_difference_with_key
will be removed.
pub fn difference_with_key<F>(self, other: Self, f: F) -> Self
difference_with_key
alias for symmetric_difference_with_key
will be removed.Construct the symmetric difference between two maps by using a function to decide what to do if a key occurs in both. The function receives the key as well as both values.
This is an alias for the
symmetric_difference_with
_key
method.
Time: O(n ^ 2)
Examples
let map1 = inOMap!{1 => 1, 3 => 4};
let map2 = inOMap!{2 => 2, 3 => 5};
let expected = inOMap!{1 => 1, 3 => 9, 2 => 2,};
assert_eq!(expected, map1.difference_with_key(
map2,
|key, left, right| Some(left + right)
));
sourcepub fn symmetric_difference_with_key<F>(self, other: Self, f: F) -> Self
pub fn symmetric_difference_with_key<F>(self, other: Self, f: F) -> Self
Construct the symmetric difference between two maps by using a function to decide what to do if a key occurs in both. The function receives the key as well as both values.
Time: O(n ^ 2)
Examples
let map1 = inOMap!{1 => 1, 3 => 4};
let map2 = inOMap!{2 => 2, 3 => 5};
let expected = inOMap!{1 => 1, 3 => 9, 2 => 2,};
assert_eq!(expected, map1.symmetric_difference_with_key(
map2,
|key, left, right| Some(left + right)
));
sourcepub fn relative_complement(self, other: Self) -> Self
pub fn relative_complement(self, other: Self) -> Self
Construct the relative complement between two maps by discarding keys
which occur in other
.
Time: O(m * n) where m is the size of the other map
Examples
let map1 = ordmap!{1 => 1, 3 => 4};
let map2 = ordmap!{2 => 2, 3 => 5};
let expected = ordmap!{1 => 1};
assert_eq!(expected, map1.relative_complement(map2));
sourcepub fn intersection(self, other: Self) -> Self
pub fn intersection(self, other: Self) -> Self
Construct the intersection of two maps, keeping the values from the current map.
Time: O(n ^ 2)
Examples
let map1 = inOMap!{1 => 1, 2 => 2};
let map2 = inOMap!{2 => 3, 3 => 4};
let expected = inOMap!{2 => 2};
assert_eq!(expected, map1.intersection(map2));
sourcepub fn intersection_with<B, C, F>(
self,
other: InOMap<K, B>,
f: F
) -> InOMap<K, C>
pub fn intersection_with<B, C, F>( self, other: InOMap<K, B>, f: F ) -> InOMap<K, C>
Construct the intersection of two maps, calling a function with both values for each key and using the result as the value for the key.
Time: O(n ^ 2)
sourcepub fn intersection_with_key<B, C, F>(
self,
other: InOMap<K, B>,
f: F
) -> InOMap<K, C>
pub fn intersection_with_key<B, C, F>( self, other: InOMap<K, B>, f: F ) -> InOMap<K, C>
Construct the intersection of two maps, calling a function with the key and both values for each key and using the result as the value for the key.
Time: O(n ^ 2)
Examples
let map1 = inOMap!{1 => 1, 2 => 2};
let map2 = inOMap!{2 => 3, 3 => 4};
let expected = inOMap!{2 => 5};
assert_eq!(expected, map1.intersection_with_key(
map2,
|key, left, right| left + right
));
Trait Implementations§
source§impl<'de, K, V> Deserialize<'de> for InOMap<K, V>where
K: Deserialize<'de> + Clone + Eq + Deref,
V: Deserialize<'de> + Clone,
<K as Deref>::Target: Eq,
impl<'de, K, V> Deserialize<'de> for InOMap<K, V>where
K: Deserialize<'de> + Clone + Eq + Deref,
V: Deserialize<'de> + Clone,
<K as Deref>::Target: Eq,
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, RK, RV> Extend<(RK, RV)> for InOMap<K, V>
impl<K, V, RK, RV> Extend<(RK, RV)> for InOMap<K, V>
source§fn extend<I>(&mut self, iter: I)where
I: IntoIterator<Item = (RK, RV)>,
fn extend<I>(&mut self, iter: I)where
I: IntoIterator<Item = (RK, RV)>,
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)