Struct im::ordmap::OrdMap

pub struct OrdMap<K, V> { /* fields omitted */ }

An ordered map.

An immutable ordered map implemented as a B-tree.

Most operations on this type of map are O(log n). A HashMap is usually a better choice for performance, but the OrdMap has the advantage of only requiring an Ord constraint on the key, and of being ordered, so that keys always come out from lowest to highest, where a HashMap has no guaranteed ordering.

Methods

impl<K, V> OrdMap<K, V>

#[must_use]

pub fn new() -> Self

Construct an empty map.

#[must_use]

pub fn unit(key: K, value: V) -> Self

Construct a map with a single mapping.

Examples

let map = OrdMap::unit(123, "onetwothree");
assert_eq!(
  map.get(&123),
  Some(&"onetwothree")
);

#[must_use]

pub fn is_empty(&self) -> bool

Test whether a map is empty.

Time: O(1)

Examples

assert!(
  !ordmap!{1 => 2}.is_empty()
);
assert!(
  OrdMap::<i32, i32>::new().is_empty()
);

#[must_use]

pub fn len(&self) -> usize

Get the size of a map.

Time: O(1)

Examples

assert_eq!(3, ordmap!{
  1 => 11,
  2 => 22,
  3 => 33
}.len());

pub fn clear(&mut self)

Discard all elements from the map.

This leaves you with an empty map, and all elements that were previously inside it are dropped.

Time: O(n)

Examples

let mut map = ordmap![1=>1, 2=>2, 3=>3];
map.clear();
assert!(map.is_empty());

impl<K, V> OrdMap<K, V> where
    K: Ord, 

#[must_use]

pub fn get_max(&self) -> Option<&(K, V)>

Get the largest key in a map, along with its value. If the map is empty, return None.

Time: O(log n)

Examples

assert_eq!(Some(&(3, 33)), ordmap!{
  1 => 11,
  2 => 22,
  3 => 33
}.get_max());

#[must_use]

pub fn get_min(&self) -> Option<&(K, V)>

Get the smallest key in a map, along with its value. If the map is empty, return None.

Time: O(log n)

Examples

assert_eq!(Some(&(1, 11)), ordmap!{
  1 => 11,
  2 => 22,
  3 => 33
}.get_min());

Important traits for Iter<'a, A>

impl<'a, A> Iterator for Iter<'a, A> where
    A: 'a + BTreeValue,  type Item = &'a A;

#[must_use]

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

Get an iterator over the key/value pairs of a map.

Important traits for Iter<'a, A>

impl<'a, A: 'a + BTreeValue> Iterator for Iter<'a, A> type Item = &'a A;

#[must_use]

pub fn range<R, BK: ?Sized>(&self, range: R) -> RangedIter<(K, V)> where
    R: RangeBounds<BK>,
    K: Borrow<BK>,
    BK: Ord, 

Important traits for Keys<'a, K, V>

impl<'a, K, V> Iterator for Keys<'a, K, V> where
    K: 'a + Ord,
    V: 'a,  type Item = &'a K;

#[must_use]

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

Get an iterator over a map's keys.

Important traits for Values<'a, K, V>

impl<'a, K, V> Iterator for Values<'a, K, V> where
    K: 'a + Ord,
    V: 'a,  type Item = &'a V;

#[must_use]

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

Get an iterator over a map's values.

Important traits for DiffIter<'a, A>

impl<'a, A> Iterator for DiffIter<'a, A> where
    A: 'a + BTreeValue + PartialEq,  type Item = DiffItem<'a, A>;

#[must_use]

pub fn diff<'a>(&'a self, other: &'a Self) -> DiffIter<'a, (K, V)>

Get an iterator over the differences between this map and another, i.e. the set of entries to add, update, or remove to this map in order to make it equal to the other map.

This function will avoid visiting nodes which are shared between the two maps, meaning that even very large maps can be compared quickly if most of their structure is shared.

Time: O(n) (where n is the number of unique elements across the two maps, minus the number of elements belonging to nodes shared between them)

#[must_use]

pub fn get<BK: ?Sized>(&self, key: &BK) -> Option<&V> where
    BK: Ord,
    K: Borrow<BK>, 

Get the value for a key from a map.

Time: O(log n)

Examples

let map = ordmap!{123 => "lol"};
assert_eq!(
  map.get(&123),
  Some(&"lol")
);

#[must_use]

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

Test for the presence of a key in a map.

Time: O(log n)

Examples

let map = ordmap!{123 => "lol"};
assert!(
  map.contains_key(&123)
);
assert!(
  !map.contains_key(&321)
);

#[must_use]

pub fn is_submap_by<B, RM, F>(&self, other: RM, cmp: F) -> bool where
    F: FnMut(&V, &B) -> bool,
    RM: Borrow<OrdMap<K, B>>, 

Test whether a map is a submap of another map, meaning that all keys in our map must also be in the other map, with the same values.

Use the provided function to decide whether values are equal.

Time: O(n log n)

#[must_use]

pub fn is_proper_submap_by<B, RM, F>(&self, other: RM, cmp: F) -> bool where
    F: FnMut(&V, &B) -> bool,
    RM: Borrow<OrdMap<K, B>>, 

Test whether a map is a proper submap of another map, meaning that all keys in our map must also be in the other map, with the same values. To be a proper submap, ours must also contain fewer keys than the other map.

Use the provided function to decide whether values are equal.

Time: O(n log n)

#[must_use]

pub fn is_submap<RM>(&self, other: RM) -> bool where
    V: PartialEq,
    RM: Borrow<Self>, 

Test whether a map is a submap of another map, meaning that all keys in our map must also be in the other map, with the same values.

Time: O(n log n)

Examples

let map1 = ordmap!{1 => 1, 2 => 2};
let map2 = ordmap!{1 => 1, 2 => 2, 3 => 3};
assert!(map1.is_submap(map2));

#[must_use]

pub fn is_proper_submap<RM>(&self, other: RM) -> bool where
    V: PartialEq,
    RM: Borrow<Self>, 

Test whether a map is a proper submap of another map, meaning that all keys in our map must also be in the other map, with the same values. To be a proper submap, ours must also contain fewer keys than the other map.

Time: O(n log n)

Examples

let map1 = ordmap!{1 => 1, 2 => 2};
let map2 = ordmap!{1 => 1, 2 => 2, 3 => 3};
assert!(map1.is_proper_submap(map2));

let map3 = ordmap!{1 => 1, 2 => 2};
let map4 = ordmap!{1 => 1, 2 => 2};
assert!(!map3.is_proper_submap(map4));

impl<K, V> OrdMap<K, V> where
    K: Ord + Clone,
    V: Clone, 

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

Insert a key/value mapping into a map.

This is a copy-on-write operation, so that the parts of the map's structure which are shared with other maps will be safely copied before mutating.

If the map already has a mapping for the given key, the previous value is overwritten.

Time: O(log n)

Examples

let mut map = ordmap!{};
map.insert(123, "123");
map.insert(456, "456");
assert_eq!(
  map,
  ordmap!{123 => "123", 456 => "456"}
);

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

Remove a key/value mapping from a map if it exists.

Time: O(log n)

Examples

let mut map = ordmap!{123 => "123", 456 => "456"};
map.remove(&123);
map.remove(&456);
assert!(map.is_empty());

pub fn remove_with_key<BK: ?Sized>(&mut self, k: &BK) -> Option<(K, V)> where
    BK: Ord,
    K: Borrow<BK>, 

Remove a key/value pair from a map, if it exists, and return the removed key and value.

Time: O(log n)

#[must_use]

pub fn update(&self, key: K, value: V) -> 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, the previous value is overwritten.

Time: O(log n)

Examples

let map = ordmap!{};
assert_eq!(
  map.update(123, "123"),
  ordmap!{123 => "123"}
);

#[must_use]

pub fn update_with<F>(self, k: K, v: V, f: F) -> Self where
    F: FnOnce(V, V) -> V, 

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 old value and the new value, and insert the result as the new value.

Time: O(log n)

#[must_use]

pub fn update_with_key<F>(self, k: K, v: V, f: F) -> Self where
    F: FnOnce(&K, V, V) -> V, 

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(log n)

#[must_use]

pub fn update_lookup_with_key<F>(self, k: K, v: V, f: F) -> (Option<V>, Self) where
    F: FnOnce(&K, &V, V) -> V, 

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(log n)

#[must_use]

pub fn alter<F>(&self, f: F, k: K) -> Self where
    F: FnOnce(Option<V>) -> Option<V>, 

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(log n)

#[must_use]

pub fn without<BK: ?Sized>(&self, k: &BK) -> Self where
    BK: Ord,
    K: Borrow<BK>, 

Remove a key/value pair from a map, if it exists.

Time: O(log n)

#[must_use]

pub fn extract<BK: ?Sized>(&self, k: &BK) -> Option<(V, Self)> where
    BK: Ord,
    K: Borrow<BK>, 

Remove a key/value pair from a map, if it exists, and return the removed value as well as the updated list.

Time: O(log n)

#[must_use]

pub fn extract_with_key<BK: ?Sized>(&self, k: &BK) -> Option<(K, V, Self)> where
    BK: Ord,
    K: Borrow<BK>, 

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(log n)

#[must_use]

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 log n)

Examples

let map1 = ordmap!{1 => 1, 3 => 3};
let map2 = ordmap!{2 => 2, 3 => 4};
let expected = ordmap!{1 => 1, 2 => 2, 3 => 3};
assert_eq!(expected, map1.union(map2));

#[must_use]

pub fn union_with<F>(self, other: Self, f: F) -> Self where
    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 log n)

#[must_use]

pub fn union_with_key<F>(self, other: Self, f: F) -> Self where
    F: FnMut(&K, 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 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 log n)

Examples

let map1 = ordmap!{1 => 1, 3 => 4};
let map2 = ordmap!{2 => 2, 3 => 5};
let expected = ordmap!{1 => 1, 2 => 2, 3 => 9};
assert_eq!(expected, map1.union_with_key(
    map2,
    |key, left, right| left + right
));

#[must_use]

pub fn unions<I>(i: I) -> Self where
    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 log n)

Examples

let map1 = ordmap!{1 => 1, 3 => 3};
let map2 = ordmap!{2 => 2};
let expected = ordmap!{1 => 1, 2 => 2, 3 => 3};
assert_eq!(expected, OrdMap::unions(vec![map1, map2]));

#[must_use]

pub fn unions_with<I, F>(i: I, f: F) -> Self where
    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 log n)

#[must_use]

pub fn unions_with_key<I, F>(i: I, f: F) -> Self where
    I: IntoIterator<Item = Self>,
    F: Fn(&K, 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 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 log n)

#[must_use]

pub fn difference(self, other: Self) -> Self

Construct the symmetric difference between two maps by discarding keys which occur in both maps.

This is an alias for the [symmetric_difference][symmetric_difference] method.

Time: O(n log n)

Examples

let map1 = ordmap!{1 => 1, 3 => 4};
let map2 = ordmap!{2 => 2, 3 => 5};
let expected = ordmap!{1 => 1, 2 => 2};
assert_eq!(expected, map1.difference(map2));

#[must_use]

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 log n)

Examples

let map1 = ordmap!{1 => 1, 3 => 4};
let map2 = ordmap!{2 => 2, 3 => 5};
let expected = ordmap!{1 => 1, 2 => 2};
assert_eq!(expected, map1.symmetric_difference(map2));

#[must_use]

pub fn difference_with<F>(self, other: Self, f: F) -> Self where
    F: FnMut(V, V) -> Option<V>, 

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][symmetric_difference_with] method.

Time: O(n log n)

#[must_use]

pub fn symmetric_difference_with<F>(self, other: Self, f: F) -> Self where
    F: FnMut(V, V) -> Option<V>, 

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 log n)

#[must_use]

pub fn difference_with_key<F>(self, other: Self, f: F) -> Self where
    F: FnMut(&K, V, V) -> Option<V>, 

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][symmetric_difference_with_key] method.

Time: O(n log n)

Examples

let map1 = ordmap!{1 => 1, 3 => 4};
let map2 = ordmap!{2 => 2, 3 => 5};
let expected = ordmap!{1 => 1, 2 => 2, 3 => 9};
assert_eq!(expected, map1.difference_with_key(
    map2,
    |key, left, right| Some(left + right)
));

#[must_use]

pub fn symmetric_difference_with_key<F>(self, other: Self, f: F) -> Self where
    F: FnMut(&K, V, V) -> Option<V>, 

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 log n)

Examples

let map1 = ordmap!{1 => 1, 3 => 4};
let map2 = ordmap!{2 => 2, 3 => 5};
let expected = ordmap!{1 => 1, 2 => 2, 3 => 9};
assert_eq!(expected, map1.symmetric_difference_with_key(
    map2,
    |key, left, right| Some(left + right)
));

#[must_use]

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 log 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));

#[must_use]

pub fn intersection(self, other: Self) -> Self

Construct the intersection of two maps, keeping the values from the current map.

Time: O(n log n)

Examples

let map1 = ordmap!{1 => 1, 2 => 2};
let map2 = ordmap!{2 => 3, 3 => 4};
let expected = ordmap!{2 => 2};
assert_eq!(expected, map1.intersection(map2));

#[must_use]

pub fn intersection_with<B, C, F>(
    self,
    other: OrdMap<K, B>,
    f: F
) -> OrdMap<K, C> where
    B: Clone,
    C: Clone,
    F: FnMut(V, B) -> 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 log n)

#[must_use]

pub fn intersection_with_key<B, C, F>(
    self,
    other: OrdMap<K, B>,
    f: F
) -> OrdMap<K, C> where
    B: Clone,
    C: Clone,
    F: FnMut(&K, V, B) -> 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 log n)

Examples

let map1 = ordmap!{1 => 1, 2 => 2};
let map2 = ordmap!{2 => 3, 3 => 4};
let expected = ordmap!{2 => 5};
assert_eq!(expected, map1.intersection_with_key(
    map2,
    |key, left, right| left + right
));

#[must_use]

pub fn split<BK: ?Sized>(&self, split: &BK) -> (Self, Self) where
    BK: Ord,
    K: Borrow<BK>, 

Split a map into two, with the left hand map containing keys which are smaller than split, and the right hand map containing keys which are larger than split.

The split mapping is discarded.

#[must_use]

pub fn split_lookup<BK: ?Sized>(&self, split: &BK) -> (Self, Option<V>, Self) where
    BK: Ord,
    K: Borrow<BK>, 

Split a map into two, with the left hand map containing keys which are smaller than split, and the right hand map containing keys which are larger than split.

Returns both the two maps and the value of split.

#[must_use]

pub fn take(&self, n: usize) -> Self

Construct a map with only the n smallest keys from a given map.

#[must_use]

pub fn skip(&self, n: usize) -> Self

Construct a map with the n smallest keys removed from a given map.

#[must_use]

pub fn without_min(&self) -> (Option<V>, Self)

Remove the smallest key from a map, and return its value as well as the updated map.

#[must_use]

pub fn without_min_with_key(&self) -> (Option<(K, V)>, Self)

Remove the smallest key from a map, and return that key, its value as well as the updated map.

#[must_use]

pub fn without_max(&self) -> (Option<V>, Self)

Remove the largest key from a map, and return its value as well as the updated map.

#[must_use]

pub fn without_max_with_key(&self) -> (Option<(K, V)>, Self)

Remove the largest key from a map, and return that key, its value as well as the updated map.

#[must_use]

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(log n)

Trait Implementations

impl<K, V> AsRef<OrdMap<K, V>> for OrdMap<K, V>

fn as_ref(&self) -> &Self

Performs the conversion.

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

fn default() -> Self

Returns the "default value" for a type.

impl<K, V> Clone for OrdMap<K, V>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V> Ord for OrdMap<K, V> where
    K: Ord,
    V: Ord, 

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<K, V, RK, RV> Extend<(RK, RV)> for OrdMap<K, V> where
    K: Ord + Clone + From<RK>,
    V: Clone + From<RV>, 

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = (RK, RV)>, 

Extends a collection with the contents of an iterator.

impl<'m, 'k, 'v, K: ?Sized, V: ?Sized, OK, OV> From<&'m OrdMap<&'k K, &'v V>> for OrdMap<OK, OV> where
    K: Ord + ToOwned<Owned = OK>,
    V: ToOwned<Owned = OV>,
    OK: Ord + Clone + Borrow<K>,
    OV: Clone + Borrow<V>, 

fn from(m: &OrdMap<&K, &V>) -> Self

Performs the conversion.

impl<'a, K, V, RK, RV, OK, OV> From<&'a [(RK, RV)]> for OrdMap<K, V> where
    K: Ord + Clone + From<OK>,
    V: Clone + From<OV>,
    OK: Borrow<RK>,
    OV: Borrow<RV>,
    RK: ToOwned<Owned = OK>,
    RV: ToOwned<Owned = OV>, 

fn from(m: &'a [(RK, RV)]) -> OrdMap<K, V>

Performs the conversion.

impl<K, V, RK, RV> From<Vec<(RK, RV)>> for OrdMap<K, V> where
    K: Ord + Clone + From<RK>,
    V: Clone + From<RV>, 

fn from(m: Vec<(RK, RV)>) -> OrdMap<K, V>

Performs the conversion.

impl<'a, K: Ord, V, RK, RV, OK, OV> From<&'a Vec<(RK, RV)>> for OrdMap<K, V> where
    K: Ord + Clone + From<OK>,
    V: Clone + From<OV>,
    OK: Borrow<RK>,
    OV: Borrow<RV>,
    RK: ToOwned<Owned = OK>,
    RV: ToOwned<Owned = OV>, 

fn from(m: &'a Vec<(RK, RV)>) -> OrdMap<K, V>

Performs the conversion.

impl<K: Ord, V, RK: Eq + Hash, RV> From<HashMap<RK, RV, RandomState>> for OrdMap<K, V> where
    K: Ord + Clone + From<RK>,
    V: Clone + From<RV>, 

fn from(m: HashMap<RK, RV>) -> OrdMap<K, V>

Performs the conversion.

impl<'a, K, V, OK, OV, RK, RV> From<&'a HashMap<RK, RV, RandomState>> for OrdMap<K, V> where
    K: Ord + Clone + From<OK>,
    V: Clone + From<OV>,
    OK: Borrow<RK>,
    OV: Borrow<RV>,
    RK: Hash + Eq + ToOwned<Owned = OK>,
    RV: ToOwned<Owned = OV>, 

fn from(m: &'a HashMap<RK, RV>) -> OrdMap<K, V>

Performs the conversion.

impl<K: Ord, V, RK, RV> From<BTreeMap<RK, RV>> for OrdMap<K, V> where
    K: Ord + Clone + From<RK>,
    V: Clone + From<RV>, 

fn from(m: BTreeMap<RK, RV>) -> OrdMap<K, V>

Performs the conversion.

impl<'a, K: Ord, V, RK, RV, OK, OV> From<&'a BTreeMap<RK, RV>> for OrdMap<K, V> where
    K: Ord + Clone + From<OK>,
    V: Clone + From<OV>,
    OK: Borrow<RK>,
    OV: Borrow<RV>,
    RK: Ord + ToOwned<Owned = OK>,
    RV: ToOwned<Owned = OV>, 

fn from(m: &'a BTreeMap<RK, RV>) -> OrdMap<K, V>

Performs the conversion.

impl<K: Ord + Hash + Eq + Clone, V: Clone, S: BuildHasher> From<HashMap<K, V, S>> for OrdMap<K, V>

fn from(m: HashMap<K, V, S>) -> Self

Performs the conversion.

impl<'a, K: Ord + Hash + Eq + Clone, V: Clone, S: BuildHasher> From<&'a HashMap<K, V, S>> for OrdMap<K, V>

fn from(m: &'a HashMap<K, V, S>) -> Self

Performs the conversion.

impl<K: Ord + Eq, V: Eq> Eq for OrdMap<K, V>

impl<K, V> PartialOrd<OrdMap<K, V>> for OrdMap<K, V> where
    K: Ord,
    V: PartialOrd, 

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<K, V> PartialEq<OrdMap<K, V>> for OrdMap<K, V> where
    K: Ord + PartialEq,
    V: PartialEq, 

default fn eq(&self, other: &Self) -> bool

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

#[must_use]

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

This method tests for !=.

impl<K, V> PartialEq<OrdMap<K, V>> for OrdMap<K, V> where
    K: Ord + Eq,
    V: Eq, 

fn eq(&self, other: &Self) -> bool

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

#[must_use]

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

This method tests for !=.

impl<'a, K, V> IntoIterator for &'a OrdMap<K, V> where
    K: Ord, 

type Item = &'a (K, V)

The type of the elements being iterated over.

type IntoIter = Iter<'a, (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, V> IntoIterator for OrdMap<K, V> where
    K: Ord + Clone,
    V: Clone, 

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = ConsumingIter<(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, V> Debug for OrdMap<K, V> where
    K: Ord + Debug,
    V: Debug, 

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

Formats the value using the given formatter.

impl<'a, K, V> Add<&'a OrdMap<K, V>> for &'a OrdMap<K, V> where
    K: Ord + Clone,
    V: Clone, 

type Output = OrdMap<K, V>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl<K, V> Add<OrdMap<K, V>> for OrdMap<K, V> where
    K: Ord + Clone,
    V: Clone, 

type Output = OrdMap<K, V>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl<'a, BK: ?Sized, K, V> Index<&'a BK> for OrdMap<K, V> where
    BK: Ord,
    K: Ord + Borrow<BK>, 

type Output = V

The returned type after indexing.

fn index(&self, key: &BK) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, BK: ?Sized, K, V> IndexMut<&'a BK> for OrdMap<K, V> where
    BK: Ord,
    K: Ord + Clone + Borrow<BK>,
    V: Clone, 

fn index_mut(&mut self, key: &BK) -> &mut Self::Output

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

impl<K, V> Hash for OrdMap<K, V> where
    K: Ord + Hash,
    V: Hash, 

fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<K, V> Sum<OrdMap<K, V>> for OrdMap<K, V> where
    K: Ord + Clone,
    V: Clone, 

fn sum<I>(it: I) -> Self where
    I: Iterator<Item = Self>, 

Method which takes an iterator and generates Self from the elements by "summing up" the items.

impl<K, V, RK, RV> FromIterator<(RK, RV)> for OrdMap<K, V> where
    K: Ord + Clone + From<RK>,
    V: Clone + From<RV>, 

fn from_iter<T>(i: T) -> Self where
    T: IntoIterator<Item = (RK, RV)>, 

Creates a value from an iterator.