Enum in_place::entry::Entry

pub enum Entry<Occ, Vac> {
    Occupied(Occ),
    Vacant(Vac),
}

An entry which is either Occupied or Vacant.

This is for manipulating key-value map collections, for example HashMap, BTreeMap (also the Set variants, but those just have V set to ()).

Variants

Occupied(Occ)

Vacant(Vac)

Implementations

impl<Occ, Vac> Entry<Occ, Vac>

pub fn from_occupied(entry: Occ) -> Self

pub fn from_vacant(entry: Vac) -> Self

impl<'c, 'e, Occ, Vac> Entry<Occ, Vac> where
    'c: 'e,
    Occ: KeyedOccupiedEntry<'c>,
    Vac: KeyedVacantEntry<'c, Value = Occ::Value, Occupied = Occ, Key = Occ::Key>, 

pub fn get_key(&'e self) -> &'e Occ::Key

get a reference to the key this entry corresponds to.

impl<'c, 'e, Occ, Vac> Entry<Occ, Vac> where
    'c: 'e,
    Occ: KeyedOccupiedEntry<'c>,
    Vac: KeyedVacantEntry<'c, Value = Occ::Value, Occupied = Occ>, 

pub fn get_pair(
    &'e self
) -> Result<(&'e Occ::Key, &'e Occ::Value), &'e Vac::Key>

get a reference to the key and value of this entry, if it’s occupied.

if it’s not occupied, get a reference to the vacant key.

pub fn get_pair_mut(
    &'e mut self
) -> Result<(&'e Occ::Key, &'e mut Occ::Value), &'e Vac::Key>

get an immutable reference to the key and a mutable reference to the value of this entry, if it’s occupied.

if it’s not occupied, get a reference to the vacant key.

pub fn into_pair(self) -> Result<(Occ::BorrowedKey, &'c mut Occ::Value), Vac>

consume this entry and return a mutable reference to the value in the collection,

if it’s not occupied, get a vacant entry.

pub fn insert_into_entry(self, value: Occ::Value) -> (Self, Option<Occ::Value>)

try to insert into the entry, returning a new entry, and a value if it was occupied.

pub fn occupy(self, value: Occ::Value) -> (Occ, Option<Occ::Value>)

set the value, returning the OccupiedEntry, and the displaced value if there was one.

pub fn is_occupied(&'e self) -> bool

returns true if the entry is occupied.

pub fn is_vacant(&'e self) -> bool

returns true if the entry is vacant.

impl<'c, Occ, Vac> Entry<Occ, Vac> where
    Occ: EntryRemovableOccupiedEntry<'c, Vacant = Vac>, 

pub fn remove_entry(self) -> (Self, Option<Occ::Value>)

remove this entry, returning a new entry. for keyed collections this will be vacant.

impl<'c, Occ, Vac> Entry<Occ, Vac> where
    Occ: RemovableOccupiedEntry<'c, Removed = Vac>, 

pub fn vacate(self) -> (Vac, Option<Occ::Value>)

remove this entry, returning the newly vacated entry, and the value if it was occupied.

impl<'c, Occ, Vac> Entry<Occ, Vac> where
    Occ: RemovableOccupiedEntry<'c, Removed = Vac>,
    Occ: KeyedOccupiedEntry<'c>,
    Vac: KeyedVacantEntry<'c, Key = Occ::Key, Occupied = Occ>, 

pub fn remove_with_key(self) -> (Occ::Key, Option<Occ::Value>)

remove the entry, and return an owned key, and an optional value, if it was occupied.

impl<'c, Occ, Vac> Entry<Occ, Vac> where
    Occ: InsertableOccupiedEntry<'c>,
    Vac: VacantEntry<'c, Occupied = Occ, Value = Occ::Value>, 

pub fn insert_new(self, value: Occ::Value)

insert a new entry in this place. if the entry is vacant, it will be filled. if it is not vacant, it will be inserted here.

pub fn occupy_new(self, value: Occ::Value) -> Occ

impl<'c, Occ, Vac> Entry<Occ, Vac> where
    Occ: NextOccupiedFromOccupied<'c>,
    Occ::Key: Ord,
    Vac: NextOccupiedFromVacant<'c, Occupied = Occ>, 

pub fn get_next_occupied(self) -> Option<Occ>

impl<'c, Occ, Vac> Entry<Occ, Vac> where
    Occ: PrevOccupiedFromOccupied<'c>,
    Occ::Key: Ord,
    Vac: PrevOccupiedFromVacant<'c, Occupied = Occ>, 

pub fn get_prev_occupied(self) -> Option<Occ>

Trait Implementations

impl<'c, Occ, Vac, K> From<EntryWithSearchKey<Occ, Vac, K>> for Entry<Occ, Vac>

fn from(entry: EntryWithSearchKey<Occ, Vac, K>) -> Self

Converts to this type from the input type.

impl<'c, Occ, Vec> IntoCollectionMut<'c> for Entry<Occ, Vec> where
    Occ: IntoCollectionMut<'c>,
    Vec: IntoCollectionMut<'c, Collection = Occ::Collection>, 

type Collection = Occ::Collection

fn into_collection_mut(self) -> &'c mut Self::Collection