Struct prometrics::label::Label
[−]
[src]
pub struct Label { /* fields omitted */ }
Metric label.
A label is a key-value pair.
Label names may contain ASCII letters, numbers, as well as underscores.
They must match the regex [a-zA-Z_][a-zA-Z0-9_]*
.
Label names beginning with __
are reserved for internal use.
Label values may contain any Unicode (utf-8) characters.
Methods
impl Label
[src]
pub fn new(name: &str, value: &str) -> Result<Self>
[src]
Makes a new Label
instance.
Errors
If name
contains invalid characters, this function returns ErrorKind::InvalidInput
error.
Examples
use prometrics::ErrorKind; use prometrics::label::Label; let label = Label::new("foo", "bar").unwrap(); assert_eq!(label.name(), "foo"); assert_eq!(label.value(), "bar"); assert_eq!(label.to_string(), r#"foo="bar""#); // Reserved name assert_eq!(Label::new("__foo", "bar").err().map(|e| *e.kind()), Some(ErrorKind::InvalidInput)); // Invalid name assert_eq!(Label::new("fo-o", "bar").err().map(|e| *e.kind()), Some(ErrorKind::InvalidInput));
pub fn name(&self) -> &str
[src]
Returns the name of this label.
pub fn value(&self) -> &str
[src]
Returns the value of this label.
Trait Implementations
impl Debug for Label
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl Clone for Label
[src]
fn clone(&self) -> Label
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl PartialEq for Label
[src]
fn eq(&self, __arg_0: &Label) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Label) -> bool
[src]
This method tests for !=
.
impl Eq for Label
[src]
impl PartialOrd for Label
[src]
fn partial_cmp(&self, __arg_0: &Label) -> Option<Ordering>
[src]
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &Label) -> bool
[src]
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &Label) -> bool
[src]
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &Label) -> bool
[src]
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &Label) -> bool
[src]
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for Label
[src]
fn cmp(&self, __arg_0: &Label) -> Ordering
[src]
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
Compares and returns the minimum of two values. Read more
impl Hash for Label
[src]
fn hash<__H: Hasher>(&self, __arg_0: &mut __H)
[src]
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more