Enum Entry

pub enum Entry<'a, T, A = Global>
where
    A: Allocator,

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

This enum is constructed from the entry method on HashTable.

Examples

# #[cfg(feature = "nightly")]
# fn test() {
use hashbrown::hash_table::{Entry, OccupiedEntry};
use hashbrown::{HashTable, DefaultHashBuilder};
use std::hash::BuildHasher;

let mut table = HashTable::new();
let hasher = DefaultHashBuilder::default();
let hasher = |val: &_| hasher.hash_one(val);
for x in ["a", "b", "c"] {
    table.insert_unique(hasher(&x), x, hasher);
}
assert_eq!(table.len(), 3);

// Existing value (insert)
let entry: Entry<_> = table.entry(hasher(&"a"), |&x| x == "a", hasher);
let _raw_o: OccupiedEntry<_, _> = entry.insert("a");
assert_eq!(table.len(), 3);
// Nonexistent value (insert)
table.entry(hasher(&"d"), |&x| x == "d", hasher).insert("d");

// Existing value (or_insert)
table
    .entry(hasher(&"b"), |&x| x == "b", hasher)
    .or_insert("b");
// Nonexistent value (or_insert)
table
    .entry(hasher(&"e"), |&x| x == "e", hasher)
    .or_insert("e");

println!("Our HashTable: {:?}", table);

let mut vec: Vec<_> = table.iter().copied().collect();
// The `Iter` iterator produces items in arbitrary order, so the
// items must be sorted to test them against a sorted array.
vec.sort_unstable();
assert_eq!(vec, ["a", "b", "c", "d", "e"]);
# }
# fn main() {
#     #[cfg(feature = "nightly")]
#     test()
# }

Variants

Occupied(OccupiedEntry<'a, T, A>)

An occupied entry.

Examples

# #[cfg(feature = "nightly")]
# fn test() {
use hashbrown::hash_table::{Entry, OccupiedEntry};
use hashbrown::{HashTable, DefaultHashBuilder};
use std::hash::BuildHasher;

let mut table = HashTable::new();
let hasher = DefaultHashBuilder::default();
let hasher = |val: &_| hasher.hash_one(val);
for x in ["a", "b"] {
    table.insert_unique(hasher(&x), x, hasher);
}

match table.entry(hasher(&"a"), |&x| x == "a", hasher) {
    Entry::Vacant(_) => unreachable!(),
    Entry::Occupied(_) => {}
}
# }
# fn main() {
#     #[cfg(feature = "nightly")]
#     test()
# }
Vacant(VacantEntry<'a, T, A>)

A vacant entry.

Examples

# #[cfg(feature = "nightly")]
# fn test() {
use hashbrown::hash_table::{Entry, OccupiedEntry};
use hashbrown::{HashTable, DefaultHashBuilder};
use std::hash::BuildHasher;

let mut table = HashTable::<&str>::new();
let hasher = DefaultHashBuilder::default();
let hasher = |val: &_| hasher.hash_one(val);

match table.entry(hasher(&"a"), |&x| x == "a", hasher) {
    Entry::Vacant(_) => {}
    Entry::Occupied(_) => unreachable!(),
}
# }
# fn main() {
#     #[cfg(feature = "nightly")]
#     test()
# }

Implementations

impl<'a, T, A> Entry<'a, T, A> where A: Allocator,

fn insert(self, value: T) -> OccupiedEntry<'a, T, A>

Sets the value of the entry, replacing any existing value if there is one, and returns an OccupiedEntry.

Examples

# #[cfg(feature = "nightly")]
# fn test() {
use hashbrown::{HashTable, DefaultHashBuilder};
use std::hash::BuildHasher;

let mut table: HashTable<&str> = HashTable::new();
let hasher = DefaultHashBuilder::default();
let hasher = |val: &_| hasher.hash_one(val);

let entry = table
    .entry(hasher(&"horseyland"), |&x| x == "horseyland", hasher)
    .insert("horseyland");

assert_eq!(entry.get(), &"horseyland");
# }
# fn main() {
#     #[cfg(feature = "nightly")]
#     test()
# }

fn or_insert(self, default: T) -> OccupiedEntry<'a, T, A>

Ensures a value is in the entry by inserting if it was vacant.

Returns an OccupiedEntry pointing to the now-occupied entry.

Examples

# #[cfg(feature = "nightly")]
# fn test() {
use hashbrown::{HashTable, DefaultHashBuilder};
use std::hash::BuildHasher;

let mut table: HashTable<&str> = HashTable::new();
let hasher = DefaultHashBuilder::default();
let hasher = |val: &_| hasher.hash_one(val);

// nonexistent key
table
    .entry(hasher(&"poneyland"), |&x| x == "poneyland", hasher)
    .or_insert("poneyland");
assert!(table
    .find(hasher(&"poneyland"), |&x| x == "poneyland")
    .is_some());

// existing key
table
    .entry(hasher(&"poneyland"), |&x| x == "poneyland", hasher)
    .or_insert("poneyland");
assert!(table
    .find(hasher(&"poneyland"), |&x| x == "poneyland")
    .is_some());
assert_eq!(table.len(), 1);
# }
# fn main() {
#     #[cfg(feature = "nightly")]
#     test()
# }

fn or_insert_with(self, default: impl FnOnce() -> T) -> OccupiedEntry<'a, T, A>

Ensures a value is in the entry by inserting the result of the default function if empty..

Returns an OccupiedEntry pointing to the now-occupied entry.

Examples

# #[cfg(feature = "nightly")]
# fn test() {
use hashbrown::{HashTable, DefaultHashBuilder};
use std::hash::BuildHasher;

let mut table: HashTable<String> = HashTable::new();
let hasher = DefaultHashBuilder::default();
let hasher = |val: &_| hasher.hash_one(val);

table
    .entry(hasher("poneyland"), |x| x == "poneyland", |val| hasher(val))
    .or_insert_with(|| "poneyland".to_string());

assert!(table
    .find(hasher(&"poneyland"), |x| x == "poneyland")
    .is_some());
# }
# fn main() {
#     #[cfg(feature = "nightly")]
#     test()
# }

fn and_modify(self, f: impl FnOnce(&mut T)) -> Self

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

Examples

# #[cfg(feature = "nightly")]
# fn test() {
use hashbrown::{HashTable, DefaultHashBuilder};
use std::hash::BuildHasher;

let mut table: HashTable<(&str, u32)> = HashTable::new();
let hasher = DefaultHashBuilder::default();
let hasher = |val: &_| hasher.hash_one(val);

table
    .entry(
        hasher(&"poneyland"),
        |&(x, _)| x == "poneyland",
        |(k, _)| hasher(&k),
    )
    .and_modify(|(_, v)| *v += 1)
    .or_insert(("poneyland", 42));
assert_eq!(
    table.find(hasher(&"poneyland"), |&(k, _)| k == "poneyland"),
    Some(&("poneyland", 42))
);

table
    .entry(
        hasher(&"poneyland"),
        |&(x, _)| x == "poneyland",
        |(k, _)| hasher(&k),
    )
    .and_modify(|(_, v)| *v += 1)
    .or_insert(("poneyland", 42));
assert_eq!(
    table.find(hasher(&"poneyland"), |&(k, _)| k == "poneyland"),
    Some(&("poneyland", 43))
);
# }
# fn main() {
#     #[cfg(feature = "nightly")]
#     test()
# }

fn into_table(self) -> &'a mut HashTable<T, A>

Converts the Entry into a mutable reference to the underlying table.

Trait Implementations

impl<T: Debug, A: Allocator> Debug for Entry<'_, T, A>

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

Auto Trait Implementations

impl<'a, T, A = Global> !UnwindSafe for Entry<'a, T, A>

impl<'a, T, A> Freeze for Entry<'a, T, A> where OccupiedEntry<'a, T, A>: Freeze, VacantEntry<'a, T, A>: Freeze,

impl<'a, T, A> RefUnwindSafe for Entry<'a, T, A> where OccupiedEntry<'a, T, A>: RefUnwindSafe, VacantEntry<'a, T, A>: RefUnwindSafe,

impl<'a, T, A> Send for Entry<'a, T, A> where OccupiedEntry<'a, T, A>: Send, VacantEntry<'a, T, A>: Send,

impl<'a, T, A> Sync for Entry<'a, T, A> where OccupiedEntry<'a, T, A>: Sync, VacantEntry<'a, T, A>: Sync,

impl<'a, T, A> Unpin for Entry<'a, T, A> where OccupiedEntry<'a, T, A>: Unpin, VacantEntry<'a, T, A>: Unpin,

impl<'a, T, A> UnsafeUnpin for Entry<'a, T, A> where OccupiedEntry<'a, T, A>: UnsafeUnpin, VacantEntry<'a, T, A>: UnsafeUnpin,

Blanket Implementations

impl<T> Any for Entry<'a, T, A> where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Entry<'a, T, A> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Entry<'a, T, A> where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for Entry<'a, T, A>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for Entry<'a, T, A> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for Entry<'a, T, A> where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for Entry<'a, T, A> where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>