Struct metered::Throughput

pub struct Throughput<T: Instant = StdInstant, P: RecordThroughput = AtomicTxPerSec<T>>(pub P, _);

A metric providing a transaction per second count backed by an histogram.

Because it retrieves the current time before calling the expression, stores it to appropriatly build time windows of 1 second and registers results to an histogram, this is a rather heavy-weight metric better applied at entry-points.

By default, Throughput uses an atomic transaction count backend and a synchronized time source, which work better in multithread scenarios. Non-threaded applications can gain performance by using unsynchronized structures instead.

Trait Implementations

impl<P: RecordThroughput + Clear, T: Instant> Clear for Throughput<T, P>

fn clear(&self)

Requests to clear self.

impl<T: Clone + Instant, P: Clone + RecordThroughput> Clone for Throughput<T, P>

fn clone(&self) -> Throughput<T, P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: RecordThroughput + Debug, T: Instant> Debug for Throughput<T, P>

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

Formats the value using the given formatter.

impl<P: RecordThroughput, T: Instant> Default for Throughput<T, P>

fn default() -> Self

Returns the "default value" for a type.

impl<P: RecordThroughput, T: Instant> Deref for Throughput<T, P>

type Target = P

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<P: RecordThroughput, T: Instant> Enter for Throughput<T, P>

type E = ()

The type returned by the enter function and carried to OnResult

fn enter(&self)

enter is called when entering in an aspect

impl<P: RecordThroughput + Serialize + Clear, T: Instant, R> Metric<R> for Throughput<T, P>

impl<P: RecordThroughput + Serialize, T: Instant, R> OnResult<R> for Throughput<T, P>

fn leave_scope(&self, _enter: ()) -> Advice

Called when an expression has exited, but the return value isn't known. This can happen because of a panic, or if control flow bypasses a macro. This is also called by the default implementation of on_result.

fn on_result(&self, enter: Self::E, _result: &R) -> Advice

Called when an expression has returned.

impl<P: RecordThroughput + Serialize, T: Instant> Serialize for Throughput<T, P>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.