Skip to main content

LruHeaderCache

Struct LruHeaderCache 

Source
pub struct LruHeaderCache { /* private fields */ }
Expand description

LRU (Least Recently Used) cache for article metadata

Implements a simple LRU cache using a HashMap and access ordering. When the cache is full, the least recently accessed entry is evicted.

§Example

use nntp_rs::cache::{HeaderCache, LruHeaderCache};
use nntp_rs::XoverEntry;

let mut cache = LruHeaderCache::new(2); // Max 2 entries

let entry1 = XoverEntry {
    article_number: 1,
    subject: "First".to_string(),
    author: "author1@example.com".to_string(),
    date: "2024-01-01".to_string(),
    message_id: "<1@example.com>".to_string(),
    references: "".to_string(),
    bytes: 100,
    lines: 10,
};

let entry2 = XoverEntry {
    article_number: 2,
    subject: "Second".to_string(),
    author: "author2@example.com".to_string(),
    date: "2024-01-02".to_string(),
    message_id: "<2@example.com>".to_string(),
    references: "".to_string(),
    bytes: 200,
    lines: 20,
    };

cache.put(1, entry1);
cache.put(2, entry2);
assert_eq!(cache.len(), 2);

// Access entry 1 to make it recently used
cache.get(&1);

// Adding a third entry will evict entry 2 (least recently used)
let entry3 = XoverEntry {
    article_number: 3,
    subject: "Third".to_string(),
    author: "author3@example.com".to_string(),
    date: "2024-01-03".to_string(),
    message_id: "<3@example.com>".to_string(),
    references: "".to_string(),
    bytes: 300,
    lines: 30,
};
cache.put(3, entry3);

assert_eq!(cache.len(), 2);
assert!(cache.contains(&1)); // Still cached
assert!(!cache.contains(&2)); // Evicted
assert!(cache.contains(&3)); // Newly added

Implementations§

Source§

impl LruHeaderCache

Source

pub fn new(max_size: usize) -> Self

Create a new LRU cache with the specified maximum size

§Arguments
  • max_size - Maximum number of entries to cache (must be > 0)
§Panics

Panics if max_size is 0

§Example
use nntp_rs::cache::{LruHeaderCache, HeaderCache};

let cache = LruHeaderCache::new(1000);
assert_eq!(cache.capacity(), 1000);
assert!(cache.is_empty());

Trait Implementations§

Source§

impl Clone for LruHeaderCache

Source§

fn clone(&self) -> LruHeaderCache

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LruHeaderCache

Source§

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

Formats the value using the given formatter. Read more
Source§

impl HeaderCache for LruHeaderCache

Source§

fn put(&mut self, article_number: u64, entry: XoverEntry)

Store an article’s overview data
Source§

fn get(&mut self, article_number: &u64) -> Option<&XoverEntry>

Retrieve an article’s overview data
Source§

fn contains(&self, article_number: &u64) -> bool

Check if an article exists in cache
Source§

fn remove(&mut self, article_number: &u64) -> Option<XoverEntry>

Remove an article from cache
Source§

fn clear(&mut self)

Clear all cached entries
Source§

fn len(&self) -> usize

Get the number of cached entries
Source§

fn capacity(&self) -> usize

Get the maximum cache size
Source§

fn is_empty(&self) -> bool

Check if cache is empty

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more