Enum stretto::Metrics

source · [−]

pub enum Metrics {
    Noop,
    Op(MetricsInner),
}

Expand description

Metrics is a snapshot of performance statistics for the lifetime of a cache instance.

Metrics promises thread-safe.

Variants

`Noop`

No operation metrics

`Op(MetricsInner)`

Op metrics

Implementations

source

impl Metrics

source

pub const fn new() -> Self

Create a Noop metrics

source

pub fn new_op() -> Self

Create a new op metrics

source

pub fn is_op(&self) -> bool

Return if the metrics is a Op metrics

source

pub fn is_noop(&self) -> bool

Return if the metrics is Noop

source

pub fn get_hits(&self) -> Option<u64>

Returns the number of Get calls where a value was found for the corresponding key.

source

pub fn get_misses(&self) -> Option<u64>

Returns the number of Get calls where a value was not found for the corresponding key.

source

pub fn get_keys_added(&self) -> Option<u64>

Returns the total number of Set calls where a new key-value item was added.

source

pub fn get_keys_updated(&self) -> Option<u64>

Returns the total number of Set calls where a new key-value item was updated.

source

pub fn get_keys_evicted(&self) -> Option<u64>

Returns the total number of keys evicted.

source

pub fn get_cost_added(&self) -> Option<u64>

Returns the sum of costs that have been added (successful Set calls).

source

pub fn get_cost_evicted(&self) -> Option<u64>

Returns the sum of all costs that have been evicted.

source

pub fn get_sets_dropped(&self) -> Option<u64>

Returns the number of Set calls that don’t make it into internal buffers (due to contention or some other reason).

source

pub fn get_sets_rejected(&self) -> Option<u64>

Returns the number of Set calls rejected by the policy (TinyLFU).

source

pub fn get_gets_dropped(&self) -> Option<u64>

Returns the number of Get counter increments that are dropped internally.

source

pub fn get_gets_kept(&self) -> Option<u64>

Returns the number of Get counter increments that are kept.

source

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

Ratio is the number of Hits over all accesses (Hits + Misses). This is the percentage of successful Get calls.

source

pub fn life_expectancy_seconds(&self) -> Option<Histogram>

Returns the histogram data of this metrics

source

pub fn clear(&self)

clear resets all the metrics

Trait Implementations

source

impl Clone for Metrics

source

fn clone(&self) -> Metrics

Returns a copy 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 Default for Metrics

source

fn default() -> Self

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

source

impl Display for Metrics

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for Metrics

impl Send for Metrics

impl Sync for Metrics

impl Unpin for Metrics

impl !UnwindSafe for Metrics

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

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

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Enum stretto::Metrics

Variants

Noop

Op(MetricsInner)

Implementations

impl Metrics

pub const fn new() -> Self

pub fn new_op() -> Self

pub fn is_op(&self) -> bool

pub fn is_noop(&self) -> bool

pub fn get_hits(&self) -> Option<u64>

pub fn get_misses(&self) -> Option<u64>

pub fn get_keys_added(&self) -> Option<u64>

pub fn get_keys_updated(&self) -> Option<u64>

pub fn get_keys_evicted(&self) -> Option<u64>

pub fn get_cost_added(&self) -> Option<u64>

pub fn get_cost_evicted(&self) -> Option<u64>

pub fn get_sets_dropped(&self) -> Option<u64>

pub fn get_sets_rejected(&self) -> Option<u64>

pub fn get_gets_dropped(&self) -> Option<u64>

pub fn get_gets_kept(&self) -> Option<u64>

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

pub fn life_expectancy_seconds(&self) -> Option<Histogram>

pub fn clear(&self)

Trait Implementations

impl Clone for Metrics

fn clone(&self) -> Metrics

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

impl Default for Metrics

fn default() -> Self

impl Display for Metrics

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

Auto Trait Implementations

impl !RefUnwindSafe for Metrics

impl Send for Metrics

impl Sync for Metrics

impl Unpin for Metrics

impl !UnwindSafe for Metrics

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

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

type Owned = T

pub fn to_owned(&self) -> T

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

impl<T> ToString for T where T: Display + ?Sized,

pub default fn to_string(&self) -> String

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

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

pub fn vzip(self) -> V

`Noop`

`Op(MetricsInner)`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

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

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

impl<T> ToString for T where
T: Display + ?Sized,

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

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

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