Enum OccupiedEntryRef

pub enum OccupiedEntryRef<'a, T: BiHashItem> {
    Unique(&'a T),
    NonUnique {
        by_key1: Option<&'a T>,
        by_key2: Option<&'a T>,
    },
}

A view into an occupied entry in a BiHashMap.

Returned by OccupiedEntry::get.

Variants

Unique(&'a T)

All keys point to the same entry.

NonUnique

The keys point to different entries, or some keys are not present.

At least one of by_key1 and by_key2 is Some.

Fields

by_key1: Option<&'a T>

The value fetched by the first key.

by_key2: Option<&'a T>

The value fetched by the second key.

Implementations

impl<'a, T: BiHashItem> OccupiedEntryRef<'a, T>

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 OccupiedEntryRef represents more than one item, or if some keys are not present.

pub fn as_unique(&self) -> Option<&'a T>

Returns a reference to the value if it is unique.

pub fn by_key1(&self) -> Option<&'a T>

Returns a reference to the value fetched by the first key.

pub fn by_key2(&self) -> Option<&'a T>

Returns a reference to the value fetched by the second key.

Trait Implementations

impl<'a, T: Debug + BiHashItem> Debug for OccupiedEntryRef<'a, T>

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

Formats the value using the given formatter.