Struct SharedCache

pub struct SharedCache {
    cache: Arc<Mutex<Cache>>,
}

A convenience wrapper around a Cache which lets it be shared between threads.

Invoking clone on a SharedCache gives a new instance which refers to the same underlying Cache object.

Fields

cache: Arc<Mutex<Cache>>

Implementations

impl SharedCache

pub fn new() -> Self

Make a new, empty, shared cache.

pub fn with_desired_size(desired_size: usize) -> Self

Create a new cache with the given desired size.

pub fn get(&self, name: &DomainName, qtype: QueryType) -> Vec<ResourceRecord>

Get an entry from the cache.

The TTL in the returned ResourceRecord is relative to the current time - not when the record was inserted into the cache.

Panics

If the mutex has been poisoned.

pub fn get_without_checking_expiration( &self, name: &DomainName, qtype: QueryType, ) -> Vec<ResourceRecord>

Like get, but may return expired entries.

Consumers MUST check that the TTL of a record is nonzero before using it!

Panics

If the mutex has been poisoned.

pub fn insert(&self, record: &ResourceRecord)

Insert an entry into the cache.

It is not inserted if its TTL is zero or negative.

This may make the cache grow beyond the desired size.

Panics

If the mutex has been poisoned.

pub fn insert_all(&self, records: &[ResourceRecord])

Insert multiple entries into the cache.

This is more efficient than calling insert multiple times, as it locks the cache just once.

Records with a TTL of zero or negative are skipped.

This may make the cache grow beyond the desired size.

Panics

If the mutex has been poisoned.

pub fn prune(&self) -> (bool, usize, usize, usize)

Atomically clears expired entries and, if the cache has grown beyond its desired size, prunes entries to get down to size.

Returns (has overflowed?, current size, num expired, num pruned).

Panics

If the mutex has been poisoned.

Trait Implementations

impl Clone for SharedCache

fn clone(&self) -> SharedCache

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SharedCache

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

Formats the value using the given formatter.

impl Default for SharedCache

fn default() -> Self

Returns the “default value” for a type.