Struct OccupiedEntry

pub struct OccupiedEntry<'a, T: BiHashItem, S = DefaultHashBuilder, A: Allocator = Global> { /* private fields */ }

A view into an occupied entry in a BiHashMap. Part of the Entry enum.

Implementations

impl<'a, T: BiHashItem, S: Clone + BuildHasher, A: Allocator> OccupiedEntry<'a, T, S, A>

pub fn is_unique(&self) -> bool

Returns true if the entry is unique.

Since BiHashMap is keyed by two keys, it’s possible for OccupiedEntry to match up to two separate items. This function returns true if the entry is unique, meaning all keys point to exactly one item.

pub fn is_non_unique(&self) -> bool

Returns true if the OccupiedEntry represents more than one item, or if some keys are not present.

pub fn get(&self) -> OccupiedEntryRef<'_, T>

Returns references to values that match the provided keys.

If you need a reference to T that may outlive the destruction of the Entry value, see into_ref.

pub fn get_mut(&mut self) -> OccupiedEntryMut<'_, T, S>

Returns mutable references to values that match the provided keys.

If you need a reference to T that may outlive the destruction of the Entry value, see into_mut.

pub fn into_ref(self) -> OccupiedEntryRef<'a, T>

Converts self into shared references to items that match the provided keys.

If you need multiple references to the OccupiedEntry, see get.

pub fn into_mut(self) -> OccupiedEntryMut<'a, T, S>

Converts self into mutable references to items that match the provided keys.

If you need multiple references to the OccupiedEntry, see get_mut.

pub fn insert(&mut self, value: T) -> Vec<T>

Sets the entry to a new value, returning all values that conflict.

Panics

Panics if the passed-in key is different from the key of the entry.

pub fn remove(self) -> Vec<T>

Takes ownership of the values from the map.

Trait Implementations

impl<'a, T: BiHashItem, S, A: Allocator> Debug for OccupiedEntry<'a, T, S, A>

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

Formats the value using the given formatter.