diff options
Diffstat (limited to 'third_party/rust/glean-core/src/traits/timing_distribution.rs')
-rw-r--r-- | third_party/rust/glean-core/src/traits/timing_distribution.rs | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/third_party/rust/glean-core/src/traits/timing_distribution.rs b/third_party/rust/glean-core/src/traits/timing_distribution.rs index 03083753c6..ba618d2b4b 100644 --- a/third_party/rust/glean-core/src/traits/timing_distribution.rs +++ b/third_party/rust/glean-core/src/traits/timing_distribution.rs @@ -66,6 +66,31 @@ pub trait TimingDistribution { /// are longer than `MAX_SAMPLE_TIME`. fn accumulate_samples(&self, samples: Vec<i64>); + /// Accumulates precisely one signed sample in the metric. + /// + /// Precludes the need for a collection in the most common use case. + /// + /// Sign is required so that the platform-specific code can provide us with + /// a 64 bit signed integer if no `u64` comparable type is available. This + /// will take care of filtering and reporting errors for any provided negative + /// sample. + /// + /// Please note that this assumes that the provided sample is already in + /// the "unit" declared by the instance of the metric type (e.g. if the + /// instance this method was called on is using [`crate::TimeUnit::Second`], then + /// `sample` is assumed to be in that unit). + /// + /// # Arguments + /// + /// * `sample` - The singular sample to be recorded by the metric. + /// + /// ## Notes + /// + /// Discards any negative value and reports an [`ErrorType::InvalidValue`]. + /// Reports an [`ErrorType::InvalidOverflow`] error if the sample is longer than + /// `MAX_SAMPLE_TIME`. + fn accumulate_single_sample(&self, sample: i64); + /// Accumulates the provided samples in the metric. /// /// # Arguments |