logo
pub enum Entry<'a, K: Ord + Default, V: Default, const N: usize> {
    Vacant(VacantEntry<'a, K, V, N>),
    Occupied(OccupiedEntry<'a, K, V, N>),
}
Expand description

A view into a single entry in a map, which may either be vacant or occupied.

This enum is constructed from the SgMap::entry method on SgMap.

Variants

Vacant(VacantEntry<'a, K, V, N>)

A vacant entry.

Occupied(OccupiedEntry<'a, K, V, N>)

An occupied entry.

Implementations

Ensures a value is in the entry by inserting the default if empty, and returns a mutable reference to the value in the entry.

Examples
use scapegoat::SgMap;

let mut map = SgMap::<&str, usize, 10>::new();
map.entry("poneyland").or_insert(12);

assert_eq!(map["poneyland"], 12);

Ensures a value is in the entry by inserting the result of the default function if empty, and returns a mutable reference to the value in the entry.

Examples
use scapegoat::SgMap;

let mut map = SgMap::<&str, usize, 10>::new();
let x = 42;
map.entry("poneyland").or_insert_with(|| x);

assert_eq!(map["poneyland"], 42);

Ensures a value is in the entry by inserting, if empty, the result of the default function. This method allows for generating key-derived values for insertion by providing the default function a reference to the key that was moved during the .entry(key) method call.

The reference to the moved key is provided so that cloning or copying the key is unnecessary, unlike with .or_insert_with(|| ... ).

Examples
use scapegoat::SgMap;

let mut map = SgMap::<&str, usize, 10>::new();

map.entry("poneyland").or_insert_with_key(|key| key.chars().count());

assert_eq!(map["poneyland"], 9);

Returns a reference to this entry’s key.

Examples
use scapegoat::SgMap;

let mut map = SgMap::<&str, usize, 10>::new();
assert_eq!(map.entry("poneyland").key(), &"poneyland");

Provides in-place mutable access to an occupied entry before any potential inserts into the map.

Examples
use scapegoat::SgMap;

let mut map = SgMap::<&str, usize, 10>::new();

map.entry("poneyland")
   .and_modify(|e| { *e += 1 })
   .or_insert(42);
assert_eq!(map["poneyland"], 42);

map.entry("poneyland")
   .and_modify(|e| { *e += 1 })
   .or_insert(42);
assert_eq!(map["poneyland"], 43);

Ensures a value is in the entry by inserting the default value if empty, and returns a mutable reference to the value in the entry.

Examples
use scapegoat::SgMap;

let mut map = SgMap::<&str, Option<usize>, 10>::new();
map.entry("poneyland").or_default();

assert_eq!(map["poneyland"], None);

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.