Struct tracing_perf::TimeReporter

source · [−]

pub struct TimeReporter { /* private fields */ }

Expand description

Collect and report total time spent on set of activities.

TimeReporter is useful for generating and reporting time reports: how much time was spend on a given activity.

On drop or on call to finish it will report total times gathered as a tracing event.

Implementations

source

impl TimeReporter

source

pub fn new<S: Into<String>>(name: S) -> Self

Create a new TimeReporter.

source

pub fn new_with_level<S: Into<String>>(name: S, level: Level) -> Self

Create a new TimeReporter with a specified level.

source

pub fn start(&mut self, key: &'static str)

Start counting time for a state named “key”.

If this TimeReporter was already counting time for another state, it will end counting time for it before starting a new one.

source

pub fn start_with<F, R>(&mut self, key: &'static str, f: F) -> R where
F: FnOnce() -> R,

Start counting time and execute a function f.

This is handy syntax for if let or while let expressions where it would be inconvenient to add a standalone start call.

source

pub fn stop(&mut self)

Stop counting time.

source

pub fn finish(self)

Finish counting time and report results.

Trait Implementations

source

impl Clone for TimeReporter

source

fn clone(&self) -> TimeReporter

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

source

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

Formats the value using the given formatter. Read more

source

impl<'a> Display for TimeReporter

source

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

Formats the value using the given formatter. Read more

source

impl Drop for TimeReporter

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl PartialEq<TimeReporter> for TimeReporter

source

fn eq(&self, other: &TimeReporter) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

fn ne(&self, other: &TimeReporter) -> bool

This method tests for !=.

source

impl Eq for TimeReporter

source

impl StructuralEq for TimeReporter

source

impl StructuralPartialEq for TimeReporter

Auto Trait Implementations

impl RefUnwindSafe for TimeReporter

impl Send for TimeReporter

impl Sync for TimeReporter

impl Unpin for TimeReporter

impl UnwindSafe for TimeReporter

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,

const: unstable · source

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

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

Mutably borrows from an owned value. Read more

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

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

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

source

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

const: unstable · 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,

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)

🔬 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

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

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

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

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct tracing_perf::TimeReporter

Implementations

impl TimeReporter

pub fn new<S: Into<String>>(name: S) -> Self

pub fn new_with_level<S: Into<String>>(name: S, level: Level) -> Self

pub fn start(&mut self, key: &'static str)

pub fn start_with<F, R>(&mut self, key: &'static str, f: F) -> R where F: FnOnce() -> R,

pub fn stop(&mut self)

pub fn finish(self)

Trait Implementations

impl Clone for TimeReporter

fn clone(&self) -> TimeReporter

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

impl Debug for TimeReporter

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

impl<'a> Display for TimeReporter

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

impl Drop for TimeReporter

fn drop(&mut self)

impl PartialEq<TimeReporter> for TimeReporter

fn eq(&self, other: &TimeReporter) -> bool

fn ne(&self, other: &TimeReporter) -> bool

impl Eq for TimeReporter

impl StructuralEq for TimeReporter

impl StructuralPartialEq for TimeReporter

Auto Trait Implementations

impl RefUnwindSafe for TimeReporter

impl Send for TimeReporter

impl Sync for TimeReporter

impl Unpin for TimeReporter

impl UnwindSafe for TimeReporter

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

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

default fn to_string(&self) -> String

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

type Error = Infallible

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

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

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn start_with<F, R>(&mut self, key: &'static str, f: F) -> R where
F: FnOnce() -> R,

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<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?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>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,