Struct metrics::Key

pub struct Key { /* fields omitted */ }

A metric key.

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

Methods

impl Key

pub fn from_name<N>(name: N) -> Key where
    N: Into<Cow<'static, str>>, 

Creates a Key from a name.

pub fn from_name_and_labels<N, L>(name: N, labels: L) -> Key where
    L: IntoLabels,
    N: Into<Cow<'static, str>>, 

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) -> Cow<'static, str>

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) -> Key where
    F: FnOnce(Cow<'static, str>) -> S,
    S: Into<Cow<'static, str>>, 

Maps the name of this Key to a new name.

pub fn into_parts(self) -> (Cow<'static, str>, Vec<Label>)

Consumes this Key, returning the name and any labels.

Trait Implementations

impl Debug for Key

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

Formats the value using the given formatter.

impl Display for Key

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

Formats the value using the given formatter.

impl Hash for Key

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

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

impl From<String> for Key

fn from(name: String) -> Key

Performs the conversion.

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

fn from(name: Cow<'static, str>) -> Key

Performs the conversion.

impl From<&'static str> for Key

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

Performs the conversion.

impl<K, L> From<(K, L)> for Key where
    K: Into<Cow<'static, str>>,
    L: IntoLabels, 

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

Performs the conversion.

impl PartialEq<Key> for Key

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

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

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

This method tests for !=.