Skip to main content

CacheStats

Struct CacheStats 

Source
#[non_exhaustive]
pub struct CacheStats { pub hits: u64, pub misses: u64, pub hit_ratio: f64, }
Expand description

Snapshot of a Config’s cache-hit / cache-miss counters.

Returned by Config::cache_stats. The struct is #[non_exhaustive] so the v1.x SemVer contract can add new counter fields (e.g. evictions, insertions, per-shard breakdowns) in MINOR releases without breaking user code.

§Stability note for v0.9.5

In v0.9.5 every CacheStats returned by Config::cache_stats has hits = 0, misses = 0, hit_ratio = 0.0. The lock-free cache layer that populates these counters lands in a follow-up v0.9.5 implementation release. The struct is shipping now so the API surface is locked in ahead of the implementation.

§Examples

use config_lib::Config;

let cfg = Config::new();
let stats = cfg.cache_stats();
assert_eq!(stats.hits, 0);
assert_eq!(stats.misses, 0);
assert_eq!(stats.hit_ratio, 0.0);

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§hits: u64

Number of cache lookups that resolved to a cached value.

§misses: u64

Number of cache lookups that did not find a cached value and fell through to the canonical storage.

§hit_ratio: f64

hits / (hits + misses) as an f64 in [0.0, 1.0]. Returns 0.0 when no lookups have happened yet.

Trait Implementations§

Source§

impl Clone for CacheStats

Source§

fn clone(&self) -> CacheStats

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 Debug for CacheStats

Source§

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

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

impl Copy for CacheStats

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.