Struct TelemetryKey 

pub struct TelemetryKey { /* private fields */ }

Compact identifier for a metric or latency sample.

Keys combine a namespace, an integer identifier, and a logical kind so that backends can map them to their own internal representation.

Implementations

impl TelemetryKey

pub const fn node(node_id: u32, kind: TelemetryKind) -> Self

Construct a key for a node level metric.

The node_id is the zero based index of the node in the graph.

pub const fn edge(edge_id: u32, kind: TelemetryKind) -> Self

Construct a key for an edge level metric.

The edge_id is the zero based index of the edge in the graph.

pub const fn runtime(kind: TelemetryKind) -> Self

Construct a key for a runtime level metric.

The identifier is currently always zero and reserved for future use.

pub const fn node_port( node_id: u32, port_index: u16, is_output: bool, kind: TelemetryKind, ) -> Self

Construct a compact key for a node port metric.

The identifier encodes the node identifier, the port index, and whether this is an input or output port into a single integer.

pub const fn ns(&self) -> &TelemetryNs

Return the namespace.

pub const fn id(&self) -> &u32

Return the identifier.

pub const fn kind(&self) -> &TelemetryKind

Return the logical kind.

Trait Implementations

impl Clone for TelemetryKey

fn clone(&self) -> TelemetryKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TelemetryKey

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

Formats the value using the given formatter.

impl Hash for TelemetryKey

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 PartialEq for TelemetryKey

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

impl Eq for TelemetryKey

impl StructuralPartialEq for TelemetryKey