Struct eytzinger_map::EytzingerMap

pub struct EytzingerMap<S>(_);

A map based on a generic slice-compatible type with Eytzinger binary search.

Examples

use eytzinger_map::EytzingerMap;

// `EytzingerMap` doesn't have insert. Build one from another map.
let mut movie_reviews = std::collections::BTreeMap::new();

// review some movies.
movie_reviews.insert("Office Space",       "Deals with real issues in the workplace.");
movie_reviews.insert("Pulp Fiction",       "Masterpiece.");
movie_reviews.insert("The Godfather",      "Very enjoyable.");

let movie_reviews: EytzingerMap<_> = movie_reviews.into_iter().collect();

// check for a specific one.
if !movie_reviews.contains_key("Les Misérables") {
    println!("We've got {} reviews, but Les Misérables ain't one.",
             movie_reviews.len());
}

// look up the values associated with some keys.
let to_find = ["Up!", "Office Space"];
for movie in &to_find {
    match movie_reviews.get(movie) {
       Some(review) => println!("{}: {}", movie, review),
       None => println!("{} is unreviewed.", movie)
    }
}

// Look up the value for a key (will panic if the key is not found).
println!("Movie review: {}", movie_reviews["Office Space"]);

// iterate over everything.
for (movie, review) in movie_reviews.iter() {
    println!("{}: \"{}\"", movie, review);
}

Implementations

impl<S> EytzingerMap<S> where
    S: AsSlice, 

pub fn new(s: S) -> Self where
    S: AsMutSlice, 

pub fn from_sorted(s: S) -> Self where
    S: AsSlice, 

pub fn get<Q: ?Sized>(&self, key: &Q) -> Option<&S::Value> where
    S::Key: Borrow<Q> + Ord,
    Q: Ord, 

Returns a reference to the value corresponding to the key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

Examples

Basic usage:

use eytzinger_map::EytzingerMap;

let map = EytzingerMap::new(vec![(1, "a")]);
assert_eq!(map.get(&1), Some(&"a"));
assert_eq!(map.get(&2), None);

pub fn get_key_value<Q: ?Sized>(&self, key: &Q) -> Option<&(S::Key, S::Value)> where
    S::Key: Borrow<Q> + Ord,
    Q: Ord, 

Returns the key-value pair corresponding to the supplied key.

The supplied key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

Examples

use eytzinger_map::EytzingerMap;

let map = EytzingerMap::new(vec![(1, "a")]);
assert_eq!(map.get_key_value(&1), Some(&(1, "a")));
assert_eq!(map.get_key_value(&2), None);

pub fn contains_key<Q: ?Sized>(&self, key: &Q) -> bool where
    S::Key: Borrow<Q> + Ord,
    Q: Ord, 

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

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

Examples

Basic usage:

use eytzinger_map::EytzingerMap;

let map = EytzingerMap::new(vec![(1, "a")]);
assert_eq!(map.contains_key(&1), true);
assert_eq!(map.contains_key(&2), false);

pub fn iter(&self) -> impl Iterator<Item = &(S::Key, S::Value)>

Gets an iterator over the entries of the map.

Examples

Basic usage:

use eytzinger_map::EytzingerMap;

let map = EytzingerMap::new(vec![(3, "c"), (2, "b"), (1, "a")]);

for (key, val) in map.iter() {
    println!("key: {} val: {}", key, val);
}

pub fn keys(&self) -> impl Iterator<Item = &S::Key>

Gets an iterator over the keys of the map.

Examples

Basic usage:

use eytzinger_map::EytzingerMap;

let map = EytzingerMap::new(vec![(2, "b"), (1, "a")]);

for key in map.keys() {
    println!("{}", key);
}

pub fn values(&self) -> impl Iterator<Item = &S::Value>

Gets an iterator over the values of the map.

Examples

Basic usage:

use eytzinger_map::EytzingerMap;

let map = EytzingerMap::new(vec![(1, "hello"), (2, "goodbye")]);

for val in map.values() {
    println!("{}", val);
}

pub fn len(&self) -> usize

Returns the number of elements in the map.

Examples

Basic usage:

use eytzinger_map::EytzingerMap;

let mut a = EytzingerMap::new(vec![]);
assert_eq!(a.len(), 0);
a = EytzingerMap::new(vec![(1, "a")]);
assert_eq!(a.len(), 1);

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

Examples

Basic usage:

use eytzinger_map::EytzingerMap;

let mut a = EytzingerMap::new(vec![]);
assert!(a.is_empty());
a = EytzingerMap::new(vec![(1, "a")]);
assert!(!a.is_empty());

impl<S> EytzingerMap<S> where
    S: AsMutSlice, 

pub fn get_mut<Q: ?Sized>(&mut self, key: &Q) -> Option<&mut S::Value> where
    S::Key: Borrow<Q> + Ord,
    Q: Ord, 

Returns a mutable reference to the value corresponding to the key.

The key may be any borrowed form of the map’s key type, but the ordering on the borrowed form must match the ordering on the key type.

Examples

Basic usage:

use eytzinger_map::EytzingerMap;

let mut map = EytzingerMap::new(vec![(1, "a")]);
if let Some(x) = map.get_mut(&1) {
    *x = "b";
}
assert_eq!(map[&1], "b");

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut (S::Key, S::Value)>

Gets a mutable iterator over the entries of the map.

Examples

Basic usage:

use eytzinger_map::EytzingerMap;

let mut map = EytzingerMap::new(vec![("a", 1), ("b", 2), ("c", 3)]);

// Update all values
for (_, val) in map.iter_mut() {
    *val *= 2;
}

for (key, val) in map.iter() {
    println!("key: {} val: {}", key, val);
}

pub fn values_mut(&mut self) -> impl Iterator<Item = &mut S::Value>

Gets a mutable iterator over the values of the map.

Examples

Basic usage:

use eytzinger_map::EytzingerMap;

let mut map = EytzingerMap::new(vec![("a", 1), ("b", 2), ("c", 3)]);

for val in map.values_mut() {
    *val = *val + 10;
}

for val in map.values() {
    println!("{}", val);
}

impl<'a, K, V> EytzingerMap<&'a [(K, V)]>

pub fn from_sorted_ref(s: &'a [(K, V)]) -> Self

pub fn from_ref(s: &'a mut [(K, V)]) -> Self

Trait Implementations

impl<S, K, V> AsMut<[(K, V)]> for EytzingerMap<S> where
    K: Ord,
    S: AsMut<[(K, V)]>, 

fn as_mut(&mut self) -> &mut [(K, V)]

Performs the conversion.

impl<S, K, V> AsRef<[(K, V)]> for EytzingerMap<S> where
    S: AsRef<[(K, V)]>, 

fn as_ref(&self) -> &[(K, V)]

Performs the conversion.

impl<S: Clone> Clone for EytzingerMap<S>

fn clone(&self) -> EytzingerMap<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for EytzingerMap<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for EytzingerMap<S>

fn default() -> EytzingerMap<S>

Returns the “default value” for a type.

impl<K, V> FromIterator<(K, V)> for EytzingerMap<Vec<(K, V)>> where
    K: Ord, 

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

Creates a value from an iterator.

impl<S: Hash> Hash for EytzingerMap<S>

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

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<Q: ?Sized, S> Index<&'_ Q> for EytzingerMap<S> where
    S::Key: Borrow<Q> + Ord,
    Q: Ord,
    S: AsSlice, 

fn index(&self, key: &Q) -> &S::Value

Returns a reference to the value corresponding to the supplied key.

Panics

Panics if the key is not present in the BTreeMap.

type Output = S::Value

The returned type after indexing.

impl<S, K, V> IntoIterator for EytzingerMap<S> where
    S: IntoIterator<Item = (K, V)>, 

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = S::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> S::IntoIter

Creates an iterator from a value.

impl<S: PartialEq> PartialEq<EytzingerMap<S>> for EytzingerMap<S>

fn eq(&self, other: &EytzingerMap<S>) -> bool

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

fn ne(&self, other: &EytzingerMap<S>) -> bool

This method tests for !=.

impl<S: Copy> Copy for EytzingerMap<S>

impl<S: Eq> Eq for EytzingerMap<S>

impl<S> StructuralEq for EytzingerMap<S>

impl<S> StructuralPartialEq for EytzingerMap<S>