Struct Diagnostic

pub struct Diagnostic {
    pub suffix: Cow<'static, str>,
    pub is_enabled: bool,
    /* private fields */
}

A timeline of DiagnosticMeasurements of a specific type. Diagnostic examples: frames per second, CPU usage, network latency

Fields

suffix: Cow<'static, str>

is_enabled: bool

Implementations

impl Diagnostic

pub fn add_measurement(&mut self, measurement: DiagnosticMeasurement)

Add a new value as a DiagnosticMeasurement.

pub fn new(path: DiagnosticPath) -> Diagnostic

Create a new diagnostic with the given path.

pub fn with_max_history_length(self, max_history_length: usize) -> Self

Set the maximum history length.

pub fn with_suffix(self, suffix: impl Into<Cow<'static, str>>) -> Self

Add a suffix to use when logging the value, can be used to show a unit.

pub fn with_smoothing_factor(self, smoothing_factor: f64) -> Self

The smoothing factor used for the exponential smoothing used for smoothed.

If measurements come in less frequently than smoothing_factor seconds apart, no smoothing will be applied. As measurements come in more frequently, the smoothing takes a greater effect such that it takes approximately smoothing_factor seconds for 83% of an instantaneous change in measurement to e reflected in the smoothed value.

A smoothing factor of 0.0 will effectively disable smoothing.

pub fn path(&self) -> &DiagnosticPath

pub fn measurement(&self) -> Option<&DiagnosticMeasurement>

Get the latest measurement from this diagnostic.

pub fn value(&self) -> Option<f64>

Get the latest value from this diagnostic.

pub fn average(&self) -> Option<f64>

Return the simple moving average of this diagnostic’s recent values. N.B. this a cheap operation as the sum is cached.

pub fn smoothed(&self) -> Option<f64>

Return the exponential moving average of this diagnostic.

This is by default tuned to behave reasonably well for a typical measurement that changes every frame such as frametime. This can be adjusted using with_smoothing_factor.

pub fn history_len(&self) -> usize

Return the number of elements for this diagnostic.

pub fn duration(&self) -> Option<Duration>

Return the duration between the oldest and most recent values for this diagnostic.

pub fn get_max_history_length(&self) -> usize

Return the maximum number of elements for this diagnostic.

pub fn values(&self) -> impl Iterator<Item = &f64>

pub fn measurements(&self) -> impl Iterator<Item = &DiagnosticMeasurement>

pub fn clear_history(&mut self)

Clear the history of this diagnostic.

Trait Implementations

impl Debug for Diagnostic

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

Formats the value using the given formatter.