Struct witchcraft_metrics::MetricId

pub struct MetricId { /* fields omitted */ }

An identifier of a metric.

It consists of a name as well as a set of tags that can be used to further filter and partition the metrics.

Implementations

impl MetricId

pub fn new<T>(name: T) -> MetricId where
    T: Into<Cow<'static, str>>, 

Creates a new metric ID with the specified name and no tags.

pub fn with_tag<K, V>(self, key: K, value: V) -> MetricId where
    K: Into<Cow<'static, str>>,
    V: Into<Cow<'static, str>>, 

A builder-style method adding a tag to the metric ID.

pub fn name(&self) -> &str

Returns the ID's name.

pub fn tags(&self) -> &Tags

Returns the ID's tags.

Trait Implementations

impl Clone for MetricId

pub fn clone(&self) -> MetricId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricId

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

Formats the value using the given formatter.

impl Eq for MetricId

impl From<&'static str> for MetricId

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

Performs the conversion.

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

pub fn from(s: Cow<'static, str>) -> MetricId

Performs the conversion.

impl From<String> for MetricId

pub fn from(s: String) -> Self

Performs the conversion.

impl Hash for MetricId

pub 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 MetricId

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

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

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

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

This method tests for !=.

impl PartialOrd<MetricId> for MetricId

pub fn partial_cmp(&self, other: &MetricId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &MetricId) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &MetricId) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &MetricId) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &MetricId) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for MetricId

impl StructuralPartialEq for MetricId