Skip to main content

UnifiedCache

Enum UnifiedCache 

Source
pub enum UnifiedCache {
    Availability(AvailabilityIndex),
    Memory(ArticleCache),
    Hybrid(HybridArticleCache),
}
Expand description

Unified cache that can be availability-only, memory-only (moka), or hybrid (foyer)

This enum provides a common interface for all cache implementations, allowing the proxy to switch between availability-only, memory, and disk-backed caching based on configuration.

Variants§

§

Availability(AvailabilityIndex)

Availability-only negative index with exact key matches.

§

Memory(ArticleCache)

Memory-only cache using moka

§

Hybrid(HybridArticleCache)

Hybrid memory+disk cache using foyer

Implementations§

Source§

impl UnifiedCache

Source

pub fn availability(ttl: Duration) -> Self

Create an availability-only negative index.

Source

pub fn memory(capacity: u64, ttl: Duration) -> Self

Create a memory-only cache

Source

pub async fn hybrid(config: HybridCacheConfig) -> Result<Self>

Create a hybrid cache (async because foyer needs async initialization)

Source

pub const fn records_backend_has_status(&self) -> bool

Returns true when successful backend responses update positive availability metadata.

Source

pub const fn stores_payload_responses(&self) -> bool

Returns true when this cache stores response payloads.

Source

pub async fn get(&self, message_id: &MessageId<'_>) -> Option<CachedArticle>

Get an article from the cache

Source

pub async fn get_request_message_id( &self, message_id: &str, ) -> Option<CachedArticle>

Get an article from a validated request message-id string (<...>).

Memory and hybrid cache hits avoid rebuilding a MessageId by looking up the stripped cache key directly.

Source

pub async fn upsert_ingest( &self, message_id: MessageId<'_>, buffer: impl Into<CacheIngestResponse>, backend: BackendId, tier: CacheTier, )

Store a successful article response for an eligible backend.

Source

pub async fn record_backend_missing( &self, message_id: MessageId<'_>, backend_id: BackendId, )

Record that a backend returned 430 for this article

Source

pub async fn record_backend_has_status( &self, message_id: MessageId<'_>, status_code: StatusCode, backend: BackendId, tier: CacheTier, )

Record that a backend has an article with a known status, without storing payload bytes.

Source

pub fn load_from_disk(&self, path: &Path) -> Result<bool>

Load persisted availability state if this is an availability-only cache.

Source

pub fn save_to_disk(&self, path: &Path) -> Result<bool>

Save persisted availability state if this is an availability-only cache.

Source

pub fn capacity(&self) -> u64

Get cache capacity

Source

pub fn entry_count(&self) -> u64

Get number of cached entries

Source

pub fn weighted_size(&self) -> u64

Get weighted size in bytes

Source

pub fn hit_rate(&self) -> f64

Get cache hit rate

Source

pub const fn is_hybrid(&self) -> bool

Check if this is a hybrid cache (has disk tier)

Source

pub const fn is_availability_only(&self) -> bool

Check if this cache is the dedicated availability-only index.

Source

pub async fn sync(&self)

Run pending background tasks (for testing)

Ensures all async maintenance tasks complete for deterministic testing.

Source

pub async fn close(&self) -> Result<()>

Close the cache and flush all pending writes

For hybrid cache, this ensures all enqueued disk writes complete before returning. For memory cache, this is a no-op (no persistent state).

Trait Implementations§

Source§

impl CacheStatsProvider for UnifiedCache

Source§

fn display_stats(&self) -> CacheDisplayStats

Get statistics for TUI display
Source§

impl Debug for UnifiedCache

Source§

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

Formats the value using the given formatter. Read more

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scope for T

Source§

fn with<F, R>(self, f: F) -> R
where Self: Sized, F: FnOnce(Self) -> R,

Scoped with ownership.
Source§

fn with_ref<F, R>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Scoped with reference.
Source§

fn with_mut<F, R>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Scoped with mutable reference.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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> Value for T
where T: Send + Sync + 'static,

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