Enum MetricsMode 

#[non_exhaustive]
pub enum MetricsMode {
    Disabled,
    Interval,
    Window(Duration),
}

Controls whether a run emits live metrics and how interval samples are shaped.

Library metrics modes are every-sample contracts. Interval forwards each libiperf interval sample, and Window forwards each completed aggregation window. Internally those streams use unbounded queues so the libiperf reporting callback is not blocked by application code. Keep the returned MetricsStream drained for long-running runs, or leave metrics disabled.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Disabled

Do not register the libiperf interval callback.

Interval

Emit one event for every libiperf interval sample.

This mode preserves every sample. It is appropriate for short runs or consumers that continuously drain the stream.

Window(Duration)

Aggregate interval samples into fixed-duration summary windows.

This mode still consumes every libiperf interval sample internally. It emits fewer public events than Interval, but the stream should still be drained for long-running runs so completed windows do not accumulate.

Implementations

impl MetricsMode

pub const fn is_enabled(self) -> bool

Return true when this mode installs the libiperf metrics callback.

Trait Implementations

impl Clone for MetricsMode

fn clone(&self) -> MetricsMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetricsMode

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

Formats the value using the given formatter.

impl Default for MetricsMode

fn default() -> MetricsMode

Returns the “default value” for a type.

impl PartialEq for MetricsMode

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for MetricsMode

impl Eq for MetricsMode

impl StructuralPartialEq for MetricsMode