Struct metrics::KeyData

pub struct KeyData { /* fields omitted */ }

Inner representation of Key.

While Key is the type that users will interact with via Recorder, KeyData is responsible for the actual storage of the name and label data.

Implementations

impl KeyData

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

Creates a KeyData from a name.

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

Creates a KeyData from a name and set of labels.

pub fn from_hybrid<L>(name_parts: &'static [SharedString], labels: L) -> Self where
    L: IntoLabels, 

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

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

Creates a KeyData 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 KeyData 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.

Trait Implementations

impl AsRef<KeyData> for Key

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

Performs the conversion.

impl Clone for KeyData

fn clone(&self) -> KeyData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyData

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

Formats the value using the given formatter.

impl Display for KeyData

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

Formats the value using the given formatter.

impl Eq for KeyData

impl From<&'static KeyData> for Key

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

Performs the conversion.

impl From<&'static str> for KeyData

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

Performs the conversion.

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

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

Performs the conversion.

impl From<KeyData> for Key

fn from(key_data: KeyData) -> Self

Performs the conversion.

impl From<String> for KeyData

fn from(name: String) -> Self

Performs the conversion.

impl Hash for KeyData

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 KeyData

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

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

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

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

This method tests for !=.

impl PartialOrd<KeyData> for KeyData

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

impl StructuralPartialEq for KeyData