[−][src]Struct glean_core::metrics::TimespanMetric
A timespan metric.
Timespans are used to make a measurement of how much time is spent in a particular task.
Implementations
impl TimespanMetric
[src]
pub fn new(meta: CommonMetricData, time_unit: TimeUnit) -> Self
[src]
Create a new timespan metric.
pub fn set_start(&mut self, glean: &Glean, start_time: u64)
[src]
Start 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 stop
): in that case the original
start time will be preserved.
pub fn set_stop(&mut self, glean: &Glean, stop_time: u64)
[src]
Stop tracking time for the provided metric. Sets the metric to the elapsed time.
This will record an error if no start
was called.
pub fn cancel(&mut self)
[src]
Abort a previous start
call. No error is recorded if no start
was called.
pub fn set_raw(&self, glean: &Glean, elapsed: Duration, overwrite: bool)
[src]
Explicitly set 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 start
/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.overwrite
- Whether or not to overwrite existing data.
pub fn test_get_value(&self, glean: &Glean, storage_name: &str) -> Option<u64>
[src]
Test-only API (exported for FFI purposes).
Get the currently stored value as an integer.
This doesn't clear the stored value.
Trait Implementations
impl Debug for TimespanMetric
[src]
impl MetricType for TimespanMetric
[src]
fn meta(&self) -> &CommonMetricData
[src]
fn meta_mut(&mut self) -> &mut CommonMetricData
[src]
fn should_record(&self, glean: &Glean) -> bool
[src]
Auto Trait Implementations
impl RefUnwindSafe for TimespanMetric
impl Send for TimespanMetric
impl Sync for TimespanMetric
impl Unpin for TimespanMetric
impl UnwindSafe for TimespanMetric
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,