Struct TimerGuard

Source

pub struct TimerGuard { /* private fields */ }

Expand description

A guard that measures elapsed time and records it as a distribution metric.

Created by the timer! macro. Records with success:true when record() is called, or success:false when dropped without calling record(). Call success() to override this behavior and record with success:true even on drop.

Tags can be added after creation via tag().

Implementations§

Source §

impl TimerGuard

Source

pub fn elapsed(&self) -> Duration

Returns the time elapsed since the guard was created.

Source

pub fn tag(self, key: &'static str, value: impl Into<SharedString>) -> Self

Adds a tag to the metric.

Source

pub fn success(self) -> Self

Changes the behavior of this guard to always record the metric with success:true, even on drop.

Source

pub fn record(self)

Consumes the guard, recording the elapsed time with success:true.

Trait Implementations§

Source §

impl Drop for TimerGuard

Source §

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl UnwindSafe for TimerGuard

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> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§