Skip to main content

CacheDiagnostics

Struct CacheDiagnostics 

Source
pub struct CacheDiagnostics {
    pub stats: CacheStats,
    pub estimated_entries: u64,
}
Expand description

User-facing diagnostic snapshot for a local cache instance.

CacheDiagnostics combines lightweight counters with runtime-level observations such as the approximate number of entries currently known to the local backend. The values are snapshots, not a durable metrics store.

§Example

use hydracache_core::{CacheDiagnostics, CacheStats};

let diagnostics = CacheDiagnostics {
    stats: CacheStats {
        hits: 1,
        misses: 1,
        ..CacheStats::default()
    },
    estimated_entries: 1,
};

assert_eq!(diagnostics.total_requests(), 2);
assert_eq!(diagnostics.hit_ratio(), Some(0.5));
assert!(!diagnostics.is_empty());

Fields§

§stats: CacheStats

Lightweight cache counters.

§estimated_entries: u64

Approximate number of entries currently held by the local backend.

This value comes from the in-memory backend and is meant for debugging and smoke checks, not billing, quotas, or exact accounting.

Implementations§

Source§

impl CacheDiagnostics

Source

pub fn total_requests(&self) -> u64

Return the number of lookup attempts represented by this snapshot.

Source

pub fn hit_ratio(&self) -> Option<f64>

Return the hit ratio represented by this snapshot.

Source

pub fn is_empty(&self) -> bool

Return whether the local backend currently appears empty.

Trait Implementations§

Source§

impl Clone for CacheDiagnostics

Source§

fn clone(&self) -> CacheDiagnostics

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for CacheDiagnostics

Source§

impl Debug for CacheDiagnostics

Source§

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

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

impl Default for CacheDiagnostics

Source§

fn default() -> CacheDiagnostics

Returns the “default value” for a type. Read more
Source§

impl PartialEq for CacheDiagnostics

Source§

fn eq(&self, other: &CacheDiagnostics) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for CacheDiagnostics

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, 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> 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.