Struct OccupiedEntry

Source

pub struct OccupiedEntry<'a, K: 'a, V: 'a> { /* private fields */ }

Expand description

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

Implementations§

Source §

impl<'a, K: Ord, V> OccupiedEntry<'a, K, V>

Source

pub fn key(&self) -> &K

Gets a reference to the key in the entry.

§Examples

use map1::BTreeMap1;

let mut map: BTreeMap1<&str, usize> = BTreeMap1::new("other", 1);
map.entry("poneyland").or_insert(12);
assert_eq!(map.entry("poneyland").key(), &"poneyland");

Source

pub fn try_remove_entry(self) -> Result<(K, V), BTreeEmptyError>

Take ownership of the key and value from the map.

§Examples

use map1::{btree_map::Entry, btree_map_1, BTreeMap1};

let mut map: BTreeMap1<&str, usize> = btree_map_1![
    ("poneyland", 12),
    ("other", 1),
];

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

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

Source

pub fn get(&self) -> &V

Gets a reference to the value in the entry.

§Examples

use map1::btree_map::{BTreeMap1, Entry};

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

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

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 map1::btree_map::{BTreeMap1, Entry};

let mut map: BTreeMap1<&str, usize> = BTreeMap1::new("other", 1);
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);

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 map1::btree_map::{BTreeMap1, Entry};

let mut map: BTreeMap1<&str, usize> = BTreeMap1::new("other", 1);
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);

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 map1::btree_map::{BTreeMap1, Entry};

let mut map: BTreeMap1<&str, usize> = BTreeMap1::new("other", 1);
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);

Source

pub fn try_remove(self) -> Result<V, BTreeEmptyError>

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

§Examples

use map1::btree_map::{BTreeMap1, Entry};

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

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