Skip to main content

Entry

Enum Entry 

Source
pub enum Entry<'a, K: 'a + Eq + Hash, V: 'a, S: 'a + BuildHasher = RandomState> {
    Occupied(OccupiedEntry<'a, K, V, S>),
    Vacant(VacantEntry<'a, K, V, S>),
}
Expand description

A view into a single entry in a cache, which may either be vacant or occupied.

This enum is constructed from the entry method on Cache.

Variants§

§

Occupied(OccupiedEntry<'a, K, V, S>)

An occupied entry

§

Vacant(VacantEntry<'a, K, V, S>)

An vacant entry

Implementations§

Source§

impl<'a, K: 'a + Eq + Hash, V: 'a, S: 'a + BuildHasher> Entry<'a, K, V, S>

Source

pub fn key(&self) -> &K

Returns a reference to this entry’s key.

§Examples
use cache_2q::Cache;

let mut cache: Cache<&str, u32> = Cache::new(8);
assert_eq!(cache.entry("poneyland").key(), &"poneyland");
Source

pub fn or_insert(self, default: V) -> &'a mut V

Ensures a value is in the entry by inserting the default if empty, and returns a mutable reference to the value in the entry.

§Examples
use cache_2q::Cache;

let mut cache = Cache::new(8);
{
    let value = cache.entry(0xFF00).or_insert(0);
    assert_eq!(*value, 0);
}

*cache.entry(0xFF00).or_insert(100) += 1;
assert_eq!(*cache.get(&0xFF00).unwrap(), 1);
Source

pub fn or_insert_with<F: FnOnce() -> V>(self, default: F) -> &'a mut V

Ensures a value is in the entry by inserting the result of the default function if empty, and returns a mutable reference to the value in the entry.

§Examples
use cache_2q::Cache;

let mut cache: Cache<&'static str, String> = Cache::new(8);
cache.entry("key").or_insert_with(|| "value".to_string());

assert_eq!(cache.get(&"key").unwrap(), &"value".to_string());
Source

pub fn and_modify<F>(self, f: F) -> Self
where F: FnOnce(&mut V),

Provides in-place mutable access to an occupied entry before any potential inserts into the map.

§Examples
use cache_2q::Cache;

let mut cache = Cache::new(1);
cache.entry("poneyland")
   .and_modify(|e| { *e += 1 })
   .or_insert(42);
assert_eq!(*cache.get("poneyland").unwrap(), 42);

cache.entry("poneyland")
   .and_modify(|e| { *e += 1 })
   .or_insert(42);
assert_eq!(*cache.get("poneyland").unwrap(), 43);
Source§

impl<'a, K: 'a + Eq + Hash, V: 'a + Default, S: 'a + BuildHasher> Entry<'a, K, V, S>

Source

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

Ensures a value is in the entry by inserting the default value if empty, and returns a mutable reference to the value in the entry.

§Examples
use cache_2q::Cache;

let mut cache = Cache::new(1);
assert_eq!(*cache.entry(1).or_default(), 0u8);
assert_eq!(cache.get(&1), Some(&mut 0))

Trait Implementations§

Source§

impl<'a, K: 'a + Debug + Eq + Hash, V: 'a + Debug, S: 'a + BuildHasher> Debug for Entry<'a, K, V, S>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, K, V, S> Freeze for Entry<'a, K, V, S>
where K: Freeze,

§

impl<'a, K, V, S> RefUnwindSafe for Entry<'a, K, V, S>

§

impl<'a, K, V, S = RandomState> !Send for Entry<'a, K, V, S>

§

impl<'a, K, V, S = RandomState> !Sync for Entry<'a, K, V, S>

§

impl<'a, K, V, S> Unpin for Entry<'a, K, V, S>
where K: Unpin,

§

impl<'a, K, V, S> UnsafeUnpin for Entry<'a, K, V, S>
where K: UnsafeUnpin,

§

impl<'a, K, V, S = RandomState> !UnwindSafe for Entry<'a, K, V, S>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where 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 T
where 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 T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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.