Struct metrics::Key

pub struct Key { /* fields omitted */ }

A metric identifier.

Implementations

impl Key

pub fn from_name<N>(name: N) -> Self where
    N: Into<NameParts>, 

Creates a Key from a name.

pub fn from_parts<N, L>(name: N, labels: L) -> Self where
    N: Into<NameParts>,
    L: IntoLabels, 

Creates a Key from a name and set of labels.

pub fn from_static_labels<N>(name: N, labels: &'static [Label]) -> Self where
    N: Into<NameParts>, 

Creates a Key from a non-static name and a static set of labels.

pub const fn from_static_name(name_parts: &'static [SharedString]) -> Self

Creates a Key from a static name.

This function is const, so it can be used in a static context.

pub const fn from_static_parts(
    name_parts: &'static [SharedString],
    labels: &'static [Label]
) -> Self

Creates a Key from a static name and static set of labels.

This function is const, so it can be used in a static context.

pub fn name(&self) -> &NameParts

Name parts of this key.

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

Labels of this key, if they exist.

pub fn append_name<S: Into<SharedString>>(self, part: S) -> Self

Appends a part to the name,

pub fn prepend_name<S: Into<SharedString>>(self, part: S) -> Self

Prepends a part to the name.

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

Consumes this Key, returning the name parts and any labels.

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

Clones this Key, and expands the existing set of labels.

pub fn get_hash(&self) -> u64

Gets the hash value for this key.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Self

Returns a copy of the value.

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

impl From<&'static str> for Key

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

Performs the conversion.

impl<N, L> From<(N, L)> for Key where
    N: Into<SharedString>,
    L: IntoLabels, 

fn from(parts: (N, L)) -> Self

Performs the conversion.

impl From<String> for Key

fn from(name: String) -> Self

Performs the conversion.

impl Hash for Key

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 Key

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

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

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

#[must_use]

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

This method tests for !=.

impl PartialOrd<Key> for Key

fn partial_cmp(&self, other: &Self) -> 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.