Struct dipstick::MetricName

pub struct MetricName { /* fields omitted */ }

The name of a metric, including the concatenated possible namespaces in which it was defined.

Implementations

impl MetricName

pub fn prepend<S: Into<NameParts>>(self, namespace: S) -> Self

Prepend to the existing namespace.

pub fn append<S: Into<NameParts>>(self, namespace: S) -> Self

Append to the existing namespace.

pub fn join(&self, separator: &str) -> String

Combine name parts into a string.

Methods from Deref<Target = NameParts>

pub fn is_within(&self, other: &NameParts) -> bool

Returns true if this instance is equal to or a subset (more specific) of the target instance. e.g. a.b.c is within a.b e.g. a.d.c is not within a.b

pub fn make_name<S: Into<String>>(&self, leaf: S) -> MetricName

Make a name in this namespace

pub fn short(&self) -> MetricName

Extract a copy of the last name part Panics if empty

Trait Implementations

impl Clone for MetricName

fn clone(&self) -> MetricName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricName

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

Formats the value using the given formatter.

impl Deref for MetricName

type Target = NameParts

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for MetricName

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Eq for MetricName

impl<S: Into<String>> From<S> for MetricName

fn from(name: S) -> Self

Performs the conversion.

impl Hash for MetricName

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for MetricName

fn cmp(&self, other: &MetricName) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<MetricName> for MetricName

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

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

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

This method tests for !=.

impl PartialOrd<MetricName> for MetricName

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for MetricName

impl StructuralPartialEq for MetricName