Struct Key

pub struct Key { /* private fields */ }

A metric key.

A key always includes a name, but can optional include multiple labels used to further describe the metric.

Implementations

impl Key

pub fn from_name<N>(name: N) -> Self

where N: Into<ScopedString>,

Creates a Key from a name.

pub fn from_name_and_labels<N, L>(name: N, labels: L) -> Self

where N: Into<ScopedString>, L: IntoLabels,

Creates a Key from a name and vector of Labels.

pub fn add_labels<L>(&mut self, new_labels: L)

where L: IntoLabels,

Adds a new set of labels to this key.

New labels will be appended to any existing labels.

pub fn name(&self) -> ScopedString

Name of this key.

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

Labels of this key, if they exist.

pub fn map_name<F, S>(self, f: F) -> Self

where F: FnOnce(ScopedString) -> S, S: Into<ScopedString>,

Maps the name of this Key to a new name.

pub fn into_parts(self) -> (ScopedString, Vec<Label>)

Consumes this Key, returning the name and any labels.

Trait Implementations

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 Display for Key

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

Formats the value using the given formatter.

impl From<&'static str> for Key

fn from(name: &'static str) -> Key

Converts to this type from the input type.

impl<K, L> From<(K, L)> for Key

where K: Into<ScopedString>, L: IntoLabels,

fn from(parts: (K, L)) -> Key

Converts to this type from the input type.

impl From<Cow<'static, str>> for Key

fn from(name: ScopedString) -> Key

Converts to this type from the input type.

impl From<String> for Key

fn from(name: String) -> Key

Converts to this type from the input type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Key

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

impl StructuralPartialEq for Key