Struct windowed_stats::experimental::series::SamplingInterval

pub struct SamplingInterval { /* private fields */ }

A time interval in which samples are folded into an aggregation.

Sampling intervals determine the timing of aggregations and interpolation in time series and are defined by the following quantities:

1. Maximum sampling period. This is the basic unit of time that defines the sampling interval and represents the maximum duration in which a sample must be observed. For any such duration in which no sample is observed, an interpolated sample is used instead. This can also be thought of as its inverse: the minimum sampling frequency.
2. Sampling period count. This is the number of sampling periods that form the sampling interval. This determines the minimum number of samples (interpolated or otherwise) folded into the aggregation for the sampling interval.
3. Capacity. This is the number of sampling intervals (and therefore aggregations) that must be stored to represent an aggregated series. This quantity is somewhat extrinsic to the time interval itself, but determines its durability.

These quantities are concatenated into a shorthand to describe sampling intervals, formatted as capacity x sampling_period_count x maximum_sampling_period. For example, a 10x2x5s sampling interval persists 10 intervals formed from two maximum sampling period of 5s. In such an interval, there is at least one sample every 5s, an aggregation every 10s, and at most 10 aggregations that represent a 100s period.

Implementations

impl SamplingInterval

pub fn durability(&self) -> Duration

Gets the durability of the interval.

Durability is the maximum period of time represented by the aggregations of a sampling interval. This is the time period for which it represents historical data.

pub fn duration(&self) -> Duration

Gets the duration of the interval (also known as the aggregation period).

pub fn max_sampling_period(&self) -> Duration

Gets the maximum sampling period of the interval.

Trait Implementations

impl Clone for SamplingInterval

fn clone(&self) -> SamplingInterval

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SamplingInterval

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

Formats the value using the given formatter.

impl Display for SamplingInterval

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

Formats the value using the given formatter.

impl From<SamplingInterval> for SamplingProfile

fn from(interval: SamplingInterval) -> Self

Converts to this type from the input type.

impl Hash for SamplingInterval

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SamplingInterval

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SamplingInterval

impl Eq for SamplingInterval

impl StructuralPartialEq for SamplingInterval