Struct alloc::collections::btree::map::entry::OccupiedEntry

1.0.0 · source ·
pub struct OccupiedEntry<'a, K, V, A: Allocator + Clone = Global> {
    pub(super) handle: Handle<NodeRef<Mut<'a>, K, V, LeafOrInternal>, KV>,
    pub(super) dormant_map: DormantMutRef<'a, BTreeMap<K, V, A>>,
    pub(super) alloc: A,
    pub(super) _marker: PhantomData<&'a mut (K, V)>,
}
Expand description

A view into an occupied entry in a BTreeMap. It is part of the Entry enum.

Fields§

§handle: Handle<NodeRef<Mut<'a>, K, V, LeafOrInternal>, KV>§dormant_map: DormantMutRef<'a, BTreeMap<K, V, A>>§alloc: A

The BTreeMap will outlive this IntoIter so we don’t care about drop order for alloc.

§_marker: PhantomData<&'a mut (K, V)>

Implementations§

source§

impl<'a, K: Ord, V, A: Allocator + Clone> OccupiedEntry<'a, K, V, A>

1.10.0 · source

pub fn key(&self) -> &K

Gets a reference to the key in the entry.

Examples
use std::collections::BTreeMap;

let mut map: BTreeMap<&str, usize> = BTreeMap::new();
map.entry("poneyland").or_insert(12);
assert_eq!(map.entry("poneyland").key(), &"poneyland");
Run
1.12.0 · source

pub fn remove_entry(self) -> (K, V)

Take ownership of the key and value from the map.

Examples
use std::collections::BTreeMap;
use std::collections::btree_map::Entry;

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

if let Entry::Occupied(o) = map.entry("poneyland") {
    // We delete the entry from the map.
    o.remove_entry();
}

// If now try to get the value, it will panic:
// println!("{}", map["poneyland"]);
Run
source

pub fn get(&self) -> &V

Gets a reference to the value in the entry.

Examples
use std::collections::BTreeMap;
use std::collections::btree_map::Entry;

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

if let Entry::Occupied(o) = map.entry("poneyland") {
    assert_eq!(o.get(), &12);
}
Run
source

pub fn get_mut(&mut self) -> &mut V

Gets a mutable reference to the value in the entry.

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

Examples
use std::collections::BTreeMap;
use std::collections::btree_map::Entry;

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

assert_eq!(map["poneyland"], 12);
if let Entry::Occupied(mut o) = map.entry("poneyland") {
    *o.get_mut() += 10;
    assert_eq!(*o.get(), 22);

    // We can use the same Entry multiple times.
    *o.get_mut() += 2;
}
assert_eq!(map["poneyland"], 24);
Run
source

pub fn into_mut(self) -> &'a mut V

Converts the entry into a mutable reference to its value.

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

Examples
use std::collections::BTreeMap;
use std::collections::btree_map::Entry;

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

assert_eq!(map["poneyland"], 12);
if let Entry::Occupied(o) = map.entry("poneyland") {
    *o.into_mut() += 10;
}
assert_eq!(map["poneyland"], 22);
Run
source

pub fn insert(&mut self, value: V) -> V

Sets the value of the entry with the OccupiedEntry’s key, and returns the entry’s old value.

Examples
use std::collections::BTreeMap;
use std::collections::btree_map::Entry;

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

if let Entry::Occupied(mut o) = map.entry("poneyland") {
    assert_eq!(o.insert(15), 12);
}
assert_eq!(map["poneyland"], 15);
Run
source

pub fn remove(self) -> V

Takes the value of the entry out of the map, and returns it.

Examples
use std::collections::BTreeMap;
use std::collections::btree_map::Entry;

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

if let Entry::Occupied(o) = map.entry("poneyland") {
    assert_eq!(o.remove(), 12);
}
// If we try to get "poneyland"'s value, it'll panic:
// println!("{}", map["poneyland"]);
Run
source

pub(super) fn remove_kv(self) -> (K, V)

Trait Implementations§

1.12.0 · source§

impl<K: Debug + Ord, V: Debug, A: Allocator + Clone> Debug for OccupiedEntry<'_, K, V, A>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, K, V, A> RefUnwindSafe for OccupiedEntry<'a, K, V, A>where A: RefUnwindSafe, K: RefUnwindSafe, V: RefUnwindSafe,

§

impl<'a, K, V, A> Send for OccupiedEntry<'a, K, V, A>where A: Send, K: Send, V: Send,

§

impl<'a, K, V, A> Sync for OccupiedEntry<'a, K, V, A>where A: Sync, K: Sync, V: Sync,

§

impl<'a, K, V, A> Unpin for OccupiedEntry<'a, K, V, A>where A: Unpin,

§

impl<'a, K, V, A = Global> !UnwindSafe for OccupiedEntry<'a, K, V, A>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.