Struct OccupiedError

pub struct OccupiedError<'a, K, V, S, A: Allocator = Global> { pub entry: OccupiedEntry<'a, K, V, S, A>, pub value: V }

The error returned by try_insert when the key already exists.

Contains the occupied entry, and the value that was not inserted.

Examples

use hashbrown::hash_map::{HashMap, OccupiedError};

let mut map: HashMap<_, _> = [("a", 10), ("b", 20)].into();

// try_insert method returns mutable reference to the value if keys are vacant,
// but if the map did have key present, nothing is updated, and the provided
// value is returned inside `Err(_)` variant
match map.try_insert("a", 100) {
    Err(OccupiedError { mut entry, value }) => {
        assert_eq!(entry.key(), &"a");
        assert_eq!(value, 100);
        assert_eq!(entry.insert(100), 10)
    }
    _ => unreachable!(),
}
assert_eq!(map[&"a"], 100);

Fields

entry: OccupiedEntry<'a, K, V, S, A>

The entry in the map that was already occupied.

value: V

The value which was not inserted, because the entry was already occupied.

Trait Implementations

impl<K: Debug, V: Debug, S, A: Allocator> Debug for OccupiedError<'_, K, V, S, A>

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

impl<K: Debug, V: Debug, S, A: Allocator> Display for OccupiedError<'_, K, V, S, A>

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

Auto Trait Implementations

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

impl<'a, K, V, S, A> Freeze for OccupiedError<'a, K, V, S, A> where OccupiedEntry<'a, K, V, S, A>: Freeze, V: Freeze,

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

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

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

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

impl<'a, K, V, S, A> UnsafeUnpin for OccupiedError<'a, K, V, S, A> where OccupiedEntry<'a, K, V, S, A>: UnsafeUnpin, V: UnsafeUnpin,

Blanket Implementations

impl<T> Any for OccupiedError<'a, K, V, S, A> where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for OccupiedError<'a, K, V, S, A> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for OccupiedError<'a, K, V, S, A> where T: ?Sized,

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

impl<T> From<T> for OccupiedError<'a, K, V, S, A>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> ToString for OccupiedError<'a, K, V, S, A> where T: Display + ?Sized,

fn to_string(&self) -> String

impl<T, U> Into<U> for OccupiedError<'a, K, V, S, A> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

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

impl<T, U> TryFrom<U> for OccupiedError<'a, K, V, S, A> where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for OccupiedError<'a, K, V, S, A> where U: TryFrom<T>,

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