Enum metrics::Key

pub enum Key {
    Borrowed(&'static KeyData),
    Owned(KeyData),
}

Represents the identifier of a metric.

Key holds either an owned or static reference variant of KeyData.

This allows for flexibility in the ways that KeyData can be passed around and reused, enabling performance improvements in specific situations.

Variants

Borrowed(&'static KeyData)

A statically borrowed KeyData.

If you are capable of keeping a static KeyData around, this variant can be used to reduce allocations and improve performance.

The reference is read-only, so you can't modify the underlying data.

Owned(KeyData)

An owned KeyData.

Useful when you need to modify a borrowed KeyData in-flight, or when there's no way to keep around a static KeyData reference.

Implementations

impl Key

pub fn into_owned(self) -> KeyData

Converts any kind of Key into an owned KeyData.

Owned variant returned as is, borrowed variant is cloned.

Methods from Deref<Target = KeyData>

pub fn name(&self) -> &ScopedString

Name of this key.

pub fn labels(&self) -> Iter<'_, Label>

Labels of this key, if they exist.

pub fn with_extra_labels(&self, extra_labels: Vec<Label>) -> Self

Returns a clone of this key with some additional labels.

Trait Implementations

impl AsRef<KeyData> for Key

#[must_use]fn as_ref(&self) -> &KeyData

Performs the conversion.

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Deref for Key

type Target = KeyData

The resulting type after dereferencing.

#[must_use]fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for Key

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

Formats the value using the given formatter.

impl Eq for Key

impl From<&'static KeyData> for Key

fn from(key_data: &'static KeyData) -> Self

Performs the conversion.

impl From<KeyData> for Key

fn from(key_data: KeyData) -> Self

Performs the conversion.

impl Hash for Key

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Key> for Key

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

We deliberately hide the differences between the containment types.

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

This method tests for !=.