Struct DescriptorCache 

pub struct DescriptorCache { /* private fields */ }

In-memory cache for Tor descriptors.

Provides automatic expiration and LRU eviction for efficient memory usage. The cache is thread-safe and can be shared across multiple tasks.

Example

use stem_rs::descriptor::cache::DescriptorCache;
use std::time::Duration;

let cache = DescriptorCache::new()
    .with_consensus_ttl(Duration::from_secs(3600))
    .with_max_entries(500);

// Cache is used automatically by Controller when enabled

Implementations

impl DescriptorCache

pub fn new() -> Self

Creates a new descriptor cache with default settings.

Default settings:

• Consensus TTL: 3 hours
• Server descriptor TTL: 24 hours
• Microdescriptor TTL: 24 hours
• Max entries: 1000

pub fn with_consensus_ttl(self, ttl: Duration) -> Self

Sets the TTL for consensus documents.

pub fn with_server_descriptor_ttl(self, ttl: Duration) -> Self

Sets the TTL for server descriptors.

pub fn with_microdescriptor_ttl(self, ttl: Duration) -> Self

Sets the TTL for microdescriptors.

pub fn with_max_entries(self, max: usize) -> Self

Sets the maximum number of cached entries.

When this limit is reached, the least recently used entries are evicted.

pub fn get_consensus(&self) -> Option<NetworkStatusDocument>

Retrieves the cached consensus document if available and not expired.

pub fn put_consensus(&self, consensus: NetworkStatusDocument)

Stores a consensus document in the cache.

pub fn get_server_descriptor( &self, fingerprint: &str, ) -> Option<ServerDescriptor>

Retrieves a cached server descriptor by fingerprint.

pub fn put_server_descriptor( &self, fingerprint: String, descriptor: ServerDescriptor, )

Stores a server descriptor in the cache.

pub fn get_microdescriptor(&self, digest: &str) -> Option<Microdescriptor>

Retrieves a cached microdescriptor by digest.

pub fn put_microdescriptor(&self, digest: String, descriptor: Microdescriptor)

Stores a microdescriptor in the cache.

pub fn clear(&self)

Clears all cached entries.

pub fn evict_expired(&self)

Removes expired entries from the cache.

pub fn stats(&self) -> CacheStats

Returns the current cache statistics.

pub fn len(&self) -> usize

Returns the number of entries currently in the cache.

pub fn is_empty(&self) -> bool

Returns true if the cache is empty.

Trait Implementations

impl Clone for DescriptorCache

fn clone(&self) -> DescriptorCache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DescriptorCache

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

Formats the value using the given formatter.

impl Default for DescriptorCache

fn default() -> Self

Returns the “default value” for a type.