Struct metrics_util::CompositeKey

pub struct CompositeKey(_, _);

A composite key that stores both the metric key and the metric kind.

This type is intended to be used by recorders that internally take advantage of the provided Registry type when also using Handle.

Since handles are opaque, having the standard key by itself could lead to two different metric kinds tryin to use the same key, calling read or write methods that inevitably panic. With CompositeKey, the kind can tied to the underlying handle, ensuring parity between the two.

Implementations

impl CompositeKey

pub const fn new(kind: MetricKind, key: Key) -> CompositeKey

Creates a new CompositeKey.

pub fn key(&self) -> &Key

Gets the inner key represented by this CompositeKey.

pub fn kind(&self) -> MetricKind

Gets the inner kind represented by this CompositeKey.

pub fn into_parts(self) -> (MetricKind, Key)

Takes the individual pieces of this CompositeKey.

Trait Implementations

impl Clone for CompositeKey

fn clone(&self) -> CompositeKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompositeKey

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

Formats the value using the given formatter.

impl Eq for CompositeKey

impl Hash for CompositeKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for CompositeKey

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<CompositeKey> for CompositeKey

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<CompositeKey> for CompositeKey

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for CompositeKey

impl StructuralPartialEq for CompositeKey