Struct Observations

pub struct Observations<T: Ord + Zero + Copy> { /* private fields */ }

Collect observations, which are sampled as a Sample.

Implementations

impl<T: Ord + Zero + Copy> Observations<T>

pub fn new(name: &'static str) -> Self

Constructor. The name parameter has no semantic meaning, and is only exposed by Observations::name().

pub fn name(&self) -> &'static str

Name associated with the observations, as provided in constructor.

pub fn sample(&self) -> Sample<T>

Take a sample of the observations. Calculates a Sample corresponding to the current state, and then clears that state.

pub fn record(&self, observation: T)

Attempt to record this T as part of the collection of observations. “Attempt”, because if a reader is currently using this ObservationSet, the observation is dropped. This prevents recording from being a blocking operation