Struct ExpiringSet 

pub struct ExpiringSet<K>(/* private fields */);

A set version of ExpiringMap. Sets V to ()

Implementations

impl<K: PartialEq + Eq + Hash> ExpiringSet<K>

pub fn new() -> Self

Create a new ExpiringSet

pub fn with_capacity(capacity: usize) -> Self

Create a new ExpiringSet with the specified capacity

pub fn insert(&mut self, key: K, ttl: Duration) -> bool

Returns true if the set contains this value

pub fn contains<Q>(&self, key: &Q) -> bool

where K: Borrow<Q>, Q: ?Sized + Hash + Eq,

Returns true if the set contains this value

pub fn take<Q>(&mut self, key: &Q) -> Option<K>

where K: Borrow<Q>, Q: ?Sized + Hash + Eq,

If it exists and has not expired, remove and return the value at this key

pub fn shrink_to_fit(&mut self)

Shrink the set to the minimum allowable size in accordance with the resize policy

pub fn shrink_to(&mut self, min_capacity: usize)

Shrink the set to the minimum of the minimum allowable size and the min_capacity in accordance with the resize policy

Methods from Deref<Target = ExpiringMap<K, ()>>

pub fn vacuum(&mut self)

Shrinks the hashmap based on entries that should no longer be contained. This is O(n).

pub fn vacuum_if_needed(&mut self)

execute a vacuum if the map has grown by more than 1.5 times

pub fn get_meta<Q>(&self, key: &Q) -> Option<&ExpiryValue<V>>

where K: Borrow<Q>, Q: ?Sized + Hash + Eq,

If the value exists and has not expired, return its expiry data

pub fn get<Q>(&self, key: &Q) -> Option<&V>

where K: Borrow<Q>, Q: ?Sized + Hash + Eq,

If the value exists and has not expired, return it

pub fn get_key_value<Q>(&self, key: &Q) -> Option<(&K, &V)>

where K: Borrow<Q>, Q: ?Sized + Hash + Eq,

If a key exists for this value, get both the key and value if it is not expired

pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut V>

where K: Borrow<Q>, Q: ?Sized + Hash + Eq,

Get a mutable reference to the value pointed to by a key, if it is not expired

pub fn insert( &mut self, key: K, value: V, ttl: Duration, ) -> Option<ExpiryValue<V>>

Insert a value into the map, returning the old value if it has not expired and existed

pub fn contains_key<Q>(&self, key: &Q) -> bool

where K: Borrow<Q>, Q: ?Sized + Hash + Eq,

If this key exists and is not expired, returns true

pub fn remove<Q>(&mut self, key: &Q) -> bool

where K: Borrow<Q>, Q: ?Sized + Hash + Eq,

Remove an item from the map. If it exists and has not expired, return true

pub fn last_size(&self) -> usize

Return the size the map was last time it was vacuumed

pub fn len(&self) -> usize

Return the number of items within the map

pub fn is_empty(&self) -> bool

Return true if the Self::len is 0

pub fn capacity(&self) -> usize

Return the capacity of the internal map

pub fn reserve(&mut self, addtional: usize)

Reserve at least a certain capacity on the internal map

pub fn shrink_to_fit(&mut self)

Remove all of the expired entries and shrink the map to the minimum allowable size in accordance with the resize policy

pub fn shrink_to(&mut self, min_capacity: usize)

Remove all of the expired entries and shrink the map to the minimum of the minimum allowable size and the min_capacity in accordance with the resize policy

pub fn remove_entry<Q>(&mut self, key: &Q) -> Option<(K, V)>

where K: Borrow<Q>, Q: ?Sized + Hash + Eq,

Removes a key from the map, returning the stored key and value if the key was previously in the map.

Trait Implementations

impl<K: Debug> Debug for ExpiringSet<K>

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

Formats the value using the given formatter.

impl<K: PartialEq + Eq + Hash> Default for ExpiringSet<K>

fn default() -> Self

Returns the “default value” for a type.

impl<K> Deref for ExpiringSet<K>

type Target = ExpiringMap<K, ()>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<K> DerefMut for ExpiringSet<K>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.