Enum Metric 

pub enum Metric {
    BinaryBytes,
    CpuMs,
    CtxSwitches,
    EnergyUj,
    IoReadBytes,
    IoWriteBytes,
    MaxRssKb,
    NetworkPackets,
    PageFaults,
    ThroughputPerS,
    WallMs,
}

Variants

BinaryBytes

CpuMs

CtxSwitches

EnergyUj

IoReadBytes

IoWriteBytes

MaxRssKb

NetworkPackets

PageFaults

ThroughputPerS

WallMs

Implementations

impl Metric

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

Returns the snake_case string key for this metric.

Examples

use perfgate_types::Metric;

assert_eq!(Metric::WallMs.as_str(), "wall_ms");
assert_eq!(Metric::ThroughputPerS.as_str(), "throughput_per_s");

pub fn parse_key(key: &str) -> Option<Self>

Parses a snake_case string key into a Metric, returning None for unknown keys.

Examples

use perfgate_types::Metric;

assert_eq!(Metric::parse_key("wall_ms"), Some(Metric::WallMs));
assert_eq!(Metric::parse_key("max_rss_kb"), Some(Metric::MaxRssKb));
assert_eq!(Metric::parse_key("unknown"), None);

pub fn default_direction(self) -> Direction

Returns the default comparison direction for this metric.

Most metrics use Direction::Lower (lower is better), except throughput which uses Direction::Higher.

Examples

use perfgate_types::{Metric, Direction};

assert_eq!(Metric::WallMs.default_direction(), Direction::Lower);
assert_eq!(Metric::ThroughputPerS.default_direction(), Direction::Higher);

pub fn default_warn_factor(self) -> f64

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

Returns the human-readable display unit for this metric.

Examples

use perfgate_types::Metric;

assert_eq!(Metric::WallMs.display_unit(), "ms");
assert_eq!(Metric::MaxRssKb.display_unit(), "KB");
assert_eq!(Metric::ThroughputPerS.display_unit(), "/s");

Trait Implementations

impl Clone for Metric

fn clone(&self) -> Metric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metric

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Metric

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Metric

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 JsonSchema for Metric

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for Metric

fn cmp(&self, other: &Metric) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Metric

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

fn partial_cmp(&self, other: &Metric) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Metric

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Metric

impl Eq for Metric

impl StructuralPartialEq for Metric