pub struct TimespanMetric { /* private fields */ }
Expand description

A timespan metric.

Timespans are used to make a measurement of how much time is spent in a particular task.

Implementations§

Creates a new timespan metric.

Starts tracking time for the provided metric.

This records an error if it’s already tracking time (i.e. start was already called with no corresponding set_stop): in that case the original start time will be preserved.

Stops tracking time for the provided metric. Sets the metric to the elapsed time.

This will record an error if no set_start was called.

Aborts a previous set_start call. No error is recorded if no set_start was called.

Explicitly sets the timespan value.

This API should only be used if your library or application requires recording times in a way that can not make use of set_start/set_stop/cancel.

Care should be taken using this if the ping lifetime might contain more than one timespan measurement. To be safe, set_raw should generally be followed by sending a custom ping containing the timespan.

Arguments
  • elapsed - The elapsed time to record.

Explicitly sets the timespan value in nanoseconds.

This API should only be used if your library or application requires recording times in a way that can not make use of set_start/set_stop/cancel.

Care should be taken using this if the ping lifetime might contain more than one timespan measurement. To be safe, set_raw should generally be followed by sending a custom ping containing the timespan.

Arguments
  • elapsed_nanos - The elapsed time to record, in nanoseconds.

Test-only API (exported for FFI purposes).

Gets the currently stored value as an integer.

This doesn’t clear the stored value.

Arguments
  • ping_name - the optional name of the ping to retrieve the metric for. Defaults to the first value in send_in_pings.
Returns

The stored value or None if nothing stored.

Exported for test purposes.

Gets the number of recorded errors for the given metric and error type.

Arguments
  • error - The type of error
Returns

The number of errors reported.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Access the stored metadata
Create a new metric from this with a new name.
Create a new metric from this with a specific label.
Whether this metric should currently be recorded Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Create a new handle for an Arc value Read more
Clone a handle Read more
Consume a handle, getting back the initial Arc<>
Get a clone of the Arc<> using a “borrowed” handle. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.