Enum Entry

pub enum Entry<'v, T, K, V>
where
    T: Ord + Clone,
    K: Hash + Eq,
    V: OrdBy<Target = T>,
{
    Occupied(RawEntry<'v, T, K, V>),
    Vacant(RawEntry<'v, T, K, V>),
}

Entry for an existing key-value pair in an ValordMap or a vacant location to insert one.

Variants

Occupied(RawEntry<'v, T, K, V>)

Existing slot with equivalent key.

Vacant(RawEntry<'v, T, K, V>)

Vacant slot (no equivalent key in the map).

Implementations

impl<'v, T, K, V> Entry<'v, T, K, V>

where T: Ord + Clone, K: Hash + Eq, V: OrdBy<Target = T>,

pub fn or_insert(&mut self, default: V) -> &mut V

Inserts default value if the entry is vacant, and returns a mutable reference to the value.

Examples

use valord_map::ValordMap;

let mut map = ValordMap::new();
map.entry("key").or_insert("value");

assert_eq!(map.get(&"key"), Some(&"value"));

pub fn or_insert_with<F: FnOnce() -> V>(&mut self, default: F) -> &mut V

Inserts a value produced by the function default if the entry is vacant, and returns a mutable reference to the value.

Examples

use valord_map::ValordMap;

let mut map = ValordMap::new();
map.entry("key").or_insert_with(|| "value");

assert_eq!(map.get(&"key"), Some(&"value"));

pub fn or_insert_with_key<F: FnOnce(&K) -> V>(&mut self, default: F) -> &mut V

Inserts a value produced by the function default with the given key if the entry is vacant, and returns a mutable reference to the value.

Examples

use valord_map::ValordMap;

let mut map = ValordMap::new();
map.entry("key").or_insert_with_key(|key| format!("value for {}", key));

assert_eq!(map.get(&"key"), Some(&"value for key".to_string()));

pub fn and_modify<F>(self, f: F) -> Self

where F: FnOnce(&mut V),

Modifies the entry if it is occupied with the function f, and returns the entry.

Examples

use valord_map::ValordMap;

let mut map = ValordMap::new();
map.entry("key").and_modify(|v| *v = "new value").or_insert("value");

assert_eq!(map.get(&"key"), Some(&"value"));

map.entry("key").and_modify(|v| *v = "new value").or_insert("value");

assert_eq!(map.get(&"key"), Some(&"new value"));

impl<'v, T, K, V> Entry<'v, T, K, V>

where T: Ord + Clone, K: Hash + Eq, V: OrdBy<Target = T> + Default,

pub fn or_default(&mut self) -> &mut V

Inserts the default value if the entry is vacant, and returns a mutable reference to the value.

Examples

use valord_map::ValordMap;

let mut map: ValordMap<usize, &str, usize> = ValordMap::new();
map.entry("key").or_default();

assert_eq!(map.get(&"key"), Some(&Default::default()));