alloc::btree_map::OccupiedEntry - Rust
Description: API documentation for the Rust `OccupiedEntry` struct in crate `alloc`.
Keywords: rust, rustlang, rust-lang, OccupiedEntry

# Struct alloc::btree_map::OccupiedEntry 1.0.0 [−] [src]

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

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

## Methods

### `impl<'a, K: Ord, V> OccupiedEntry<'a, K, V>`
[src]

#### `pub fn key(&self) -> &K`
1.10.0
[src]

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");

#### `pub fn remove_entry(self) -> (K, V)`
1.12.0
[src]

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"]);

#### `pub fn get(&self) -> &V`
[src]

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);
    }

#### `pub fn get_mut(&mut self) -> &mut V`
[src]

Gets a mutable 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);

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

#### `pub fn into_mut(self) -> &'a mut V`
[src]

Converts the entry into a mutable reference to its 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);

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

#### `pub fn insert(&mut self, value: V) -> V`
[src]

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);

#### `pub fn remove(self) -> V`
[src]

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"]);

## Trait Implementations

### `impl<'a, K: 'a + Debug + Ord, V: 'a + Debug> Debug for OccupiedEntry<'a, K, V>`
1.12.0
[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter. Read more

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
↑
  Move up in search results
↓
  Move down in search results
↹
  Switch tab
⏎
  Go to active search result
+ / -
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)