Enum Instruments

#[repr(usize)]
pub enum Instruments {
    NoInstruments = 0,
    LogsWithoutMetrics = 32,
    LogsWithMetrics = 103,
    LogsWithExpensiveMetrics = 107,
    MetricsWithoutLogs = 7,
    ExpensiveMetricsWithoutLogs = 11,
    Custom(usize),
}

Honors the Zero-Cost Instrumentation Pattern for the [stream_executors]:
Designed to be used as a const generic parameter for Structs, causes the conditional instrumentation code in client structs to be selectively compiled – see the implemented const methods for documentation of each available instrument.

Note: Using this enum directly in generics – as in struct S<const INSTUMENTS: Instruments = { Instruments::NoInstruments }> {...} – is not possible yet (as of Rust 1.64): “adt const params is experimental [E0658]”, so we’ll use it as struct S<const INSTRUMENTS: usize = 0> instead, and use [Instruments::from(INSTRUMENTS)] in the instrumentable implementations & let s = S::<Instruments::<YourOption>::into()> {}; in clients.

Variants

NoInstruments = 0

No conditional instrumentation code will be included – bringing in the fastest possible execution speeds at the expense of lowest operational control

LogsWithoutMetrics = 32

LogsWithMetrics = 103

LogsWithExpensiveMetrics = 107

MetricsWithoutLogs = 7

ExpensiveMetricsWithoutLogs = 11

Custom(usize)

Implementations

impl Instruments

pub const fn from(instruments: usize) -> Self

To be used in if conditions, returns the enum variant that corresponds to the given const generic numeric value as described in Self

pub const fn into(self) -> usize

designed to be used by clients of the implementor structs, returns the number to be used as a const generic numeric value (when instantiating the implementor struct) that corresponds to the given enum variant

pub const fn logging(self) -> bool

returns whether executors should log start/stop in the INFO level OR events TRACING

pub const fn tracing(self) -> bool

returns whether executors should log events in the TRACING level

pub const fn cheap_profiling(self) -> bool

returns whether executors should compute the CHEAP_PROFILING metrics

pub const fn metrics(self) -> bool

returns whether executors should compute any of the available metrics

Trait Implementations

impl Clone for Instruments

fn clone(&self) -> Instruments

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instruments

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

Formats the value using the given formatter.

impl PartialEq for Instruments

fn eq(&self, other: &Instruments) -> 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 Instruments

impl StructuralPartialEq for Instruments