Struct intmap::IntMap

pub struct IntMap<V> { /* private fields */ }

Implementations

impl<V> IntMap<V>

pub fn new() -> Self

Creates a new IntMap.

Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::new();
assert_eq!(map, IntMap::default());

pub fn with_capacity(capacity: usize) -> Self

Creates a new IntMap with at least the given capacity, rounded to the next power of two.

Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::with_capacity(20);

pub fn set_load_factor(&mut self, load_factor: f32)

Sets load rate of IntMap rounded to the first decimal point.

Values above 1.0 is allowed.

Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::with_capacity(20);
map.set_load_factor(0.909); // Sets load factor to 90.9%

pub fn get_load_factor(&self) -> f32

Returns current load_factor

pub fn reserve(&mut self, additional: usize)

Ensures that the IntMap has space for at least additional more elements

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

Insert key/value into the IntMap.

This function returns the previous value if any otherwise None.

Examples

use intmap::IntMap;

let mut map = IntMap::new();
assert_eq!(map.insert(21, "Eat my shorts"), None);
assert_eq!(map.insert(21, "Ay, caramba"), Some("Eat my shorts"));
assert_eq!(map.get(21), Some(&"Ay, caramba"));

pub fn insert_checked(&mut self, key: u64, value: V) -> bool

Insert key/value into the IntMap if the key is not yet inserted.

This function returns true if key/value were inserted and false otherwise.

Examples

use intmap::IntMap;

let mut map = IntMap::new();
assert!(map.insert_checked(21, "Eat my shorts"));
assert!(!map.insert_checked(21, "Ay, caramba"));
assert_eq!(map.get(21), Some(&"Eat my shorts"));

pub fn get(&self, key: u64) -> Option<&V>

Get value from the IntMap.

Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::new();
map.insert(21, 42);
let val = map.get(21);
assert!(val.is_some());
assert_eq!(*val.unwrap(), 42);
assert!(map.contains_key(21));

pub fn get_mut(&mut self, key: u64) -> Option<&mut V>

Get mutable value from the IntMap.

Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::new();
map.insert(21, 42);

assert_eq!(*map.get(21).unwrap(), 42);
assert!(map.contains_key(21));

{
    let mut val = map.get_mut(21).unwrap();
    *val+=1;
}
    assert_eq!(*map.get(21).unwrap(), 43);

pub fn remove(&mut self, key: u64) -> Option<V>

Remove value from the IntMap.

Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::new();
map.insert(21, 42);
let val = map.remove(21);
assert!(val.is_some());
assert_eq!(val.unwrap(), 42);
assert!(!map.contains_key(21));

pub fn contains_key(&self, key: u64) -> bool

Returns true if key is in map.

Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::new();
map.insert(21, 42);
assert!(map.contains_key(21));

pub fn clear(&mut self)

Removes all elements from map.

Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::new();
map.insert(21, 42);
map.clear();
assert_eq!(map.len(), 0);

pub fn retain<F>(&mut self, f: F) where
    F: FnMut(u64, &V) -> bool, 

Retains only the elements specified by the predicate.

In other words, remove all elements such that f(key, &value) returns false.

Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::new();
map.insert(1, 11);
map.insert(2, 12);
map.insert(4, 13);

// retain only the odd values
map.retain(|k, v| *v % 2 == 1);

assert_eq!(map.len(), 2);
assert!(map.contains_key(1));
assert!(map.contains_key(4));

pub fn is_empty(&self) -> bool

Returns true if map is empty

Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::new();
map.insert(21, 42);
assert!(!map.is_empty());
map.remove(21);
assert!(map.is_empty());

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

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

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

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

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

pub fn drain(&mut self) -> Drain<'_, u64, V>

pub fn len(&self) -> usize

Number of elements in map.

pub fn load(&self) -> u64

Force count number of slots filled.

pub fn load_rate(&self) -> f64

pub fn capacity(&self) -> usize

Total number of slots available.

pub fn assert_count(&self) -> bool

pub fn collisions(&self) -> IntMap<u64>

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

Gets the Entry that corresponds to the given key.

Examples

use intmap::{IntMap, Entry};

let mut counters = IntMap::new();

for number in [10, 30, 10, 40, 50, 50, 60, 50] {
    let counter = match counters.entry(number) {
        Entry::Occupied(entry) => entry.into_mut(),
        Entry::Vacant(entry) => entry.insert(0),
    };
    *counter += 1;
}

assert_eq!(counters.get(10), Some(&2));
assert_eq!(counters.get(20), None);
assert_eq!(counters.get(30), Some(&1));
assert_eq!(counters.get(40), Some(&1));
assert_eq!(counters.get(50), Some(&3));
assert_eq!(counters.get(60), Some(&1));

Trait Implementations

impl<V: Clone> Clone for IntMap<V>

fn clone(&self) -> IntMap<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V> Debug for IntMap<V> where
    V: Debug, 

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

Formats the value using the given formatter.

impl<V> Default for IntMap<V>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for IntMap<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<V> Extend<(u64, V)> for IntMap<V>

fn extend<T: IntoIterator<Item = (u64, V)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<V> FromIterator<(u64, V)> for IntMap<V>

fn from_iter<T: IntoIterator<Item = (u64, V)>>(iter: T) -> Self

Creates a value from an iterator.

impl<V> IntoIterator for IntMap<V>

type Item = (u64, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<u64, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<V> PartialEq<IntMap<V>> for IntMap<V> where
    V: PartialEq, 

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

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

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

This method tests for !=.

impl<T: Serialize> Serialize for IntMap<T>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<V> Eq for IntMap<V> where
    V: Eq,