Struct GlobalCache

pub struct GlobalCache;

Available on crate feature cache only.

Global cache built on the top of LruCache.

Implementations

impl GlobalCache

pub fn put( key: impl Into<String>, value: impl Into<JsonValue>, ) -> Option<JsonValue>

Puts a key-value pair into the global cache. If the key already exists in the cache, then it updates the key’s value and returns the old value. Otherwise, None is returned.

pub fn push( key: impl Into<String>, value: impl Into<JsonValue>, ) -> Option<(String, JsonValue)>

Pushes a key-value pair into the global cache. If an entry with the key already exists in the cache or another cache entry is removed (due to the LRU’s capacity), then it returns the old entry’s key-value pair. Otherwise, returns None.

pub fn get(key: &str) -> Option<JsonValue>

Returns a cloned value of the key in the global cache or None if it is not present in the cache. Moves the key to the head of the LRU list if it exists.

pub fn peek(key: &str) -> Option<JsonValue>

Returns a cloned value of the key in the global cache or None if it is not present in the cache. It does not update the LRU list so the key’s position will be unchanged.

pub fn contains(key: &str) -> bool

Returns a bool indicating whether the given key is in the global cache. Does not update the LRU list.

pub fn pop(key: &str) -> Option<JsonValue>

Removes and returns the value corresponding to the key from the global cache or None if it does not exist.

pub fn pop_entry(key: &str) -> Option<(String, JsonValue)>

Removes and returns the key-value pair from the global cache or None if it does not exist.

pub fn pop_lru() -> Option<(String, JsonValue)>

Removes and returns the key-value pair corresponding to the least recently used item or None if the global cache is empty.

pub fn promote(key: &str)

Marks the key as the most recently used one.

pub fn demote(key: &str)

Marks the key as the least recently used one.

pub fn len() -> usize

Returns the number of key-value pairs that are currently in the global cache.

pub fn is_empty() -> bool

Returns a bool indicating whether the global cache is empty or not.

pub fn cap() -> NonZeroUsize

Returns the maximum number of key-value pairs the global cache can hold.

pub fn resize(cap: NonZeroUsize)

Resizes the global cache. If the new capacity is smaller than the size of the current cache any entries past the new capacity are discarded.

pub fn clear()

Clears the contents of the global cache.

Trait Implementations

impl Clone for GlobalCache

fn clone(&self) -> GlobalCache

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GlobalCache

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

Formats the value using the given formatter.

impl Default for GlobalCache

fn default() -> GlobalCache

Returns the “default value” for a type.

impl Copy for GlobalCache