[][src]Struct witchcraft_metrics::Meter

pub struct Meter { /* fields omitted */ }

A metric tracking the rate of occurrence of an event.

The meter tracks rolling average rates in the same manner as the Linux kernel's load factor measurement.

Implementations

impl Meter[src]

pub fn new() -> Meter[src]

Creates a new meter with a SystemClock.

pub fn new_with(clock: Arc<dyn Clock>) -> Meter[src]

Creates a new meter using the provided Clock as its time source.

pub fn mark(&self, n: i64)[src]

Mark the occurrence of n event(s).

pub fn count(&self) -> i64[src]

Returns the number of events registered by the meter.

pub fn one_minute_rate(&self) -> f64[src]

Returns the one minute rolling average rate of the occurrence of events measured in events per second.

pub fn five_minute_rate(&self) -> f64[src]

Returns the five minute rolling average rate of the occurrence of events measured in events per second.

pub fn fifteen_minute_rate(&self) -> f64[src]

Returns the fifteen minute rolling average rate of the occurrence of events measured in events per second.

pub fn mean_rate(&self) -> f64[src]

Returns the mean rate of the occurrence of events since the creation of the meter measured in events per second.

Trait Implementations

impl Default for Meter[src]

Auto Trait Implementations

impl !RefUnwindSafe for Meter

impl Send for Meter

impl Sync for Meter

impl Unpin for Meter

impl !UnwindSafe for Meter

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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