Skip to main content

LabelSet

Struct LabelSet 

Source
pub struct LabelSet { /* private fields */ }
Expand description

An ordered, deduplicated set of label key/value pairs.

LabelSet maintains its inner Vec<Label> sorted by key for stable hashing and rendering: two semantically equivalent sets (same pairs in any insertion order) compare equal, hash equal, and render identically.

Construction is allocation-free for an empty set (LabelSet::EMPTY) and allocates the backing Vec on first insertion.

Implementations§

Source§

impl LabelSet

Source

pub const EMPTY: LabelSet

The empty label set. Suitable for use as a const default.

Source

pub const fn new() -> Self

Construct a new, empty label set.

Source

pub fn len(&self) -> usize

Number of (key, value) pairs in the set.

Source

pub fn is_empty(&self) -> bool

true when the set has no pairs.

Source

pub fn iter(&self) -> impl Iterator<Item = (&str, &str)> + '_

Iterate label pairs as (&str, &str) in sorted order.

Source

pub fn add( &mut self, key: impl Into<Cow<'static, str>>, value: impl Into<Cow<'static, str>>, ) -> &mut Self

Insert a (key, value) pair, replacing any existing value for key.

Maintains sort order via binary_search_by. Returns &mut self for chaining.

Source

pub fn with( self, key: impl Into<Cow<'static, str>>, value: impl Into<Cow<'static, str>>, ) -> Self

Builder-style insert: consumes self and returns it with (key, value) added or replaced.

Source

pub fn get(&self, key: &str) -> Option<&str>

Lookup a label value by key.

Source

pub fn remove(&mut self, key: &str) -> bool

Remove a label by key. Returns true if a pair was removed.

Source

pub fn to_prometheus(&self) -> String

Render labels in Prometheus / OpenMetrics format: {k="v",k="v"}.

Returns an empty string for an empty set. Label values are escaped per the Prometheus exposition format: \\\, "\", \n\n. Label keys are emitted verbatim (Prometheus requires [a-zA-Z_][a-zA-Z0-9_]*); callers are responsible for choosing valid keys.

Source

pub fn to_statsd(&self) -> String

Render labels in StatsD DogStatsD format: |#k:v,k:v.

Returns an empty string for an empty set. Values are sanitised by replacing |, ,, \n, and : with _ (the format has no escape sequence; sanitisation is the standard practice).

Trait Implementations§

Source§

impl Clone for LabelSet

Source§

fn clone(&self) -> LabelSet

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LabelSet

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for LabelSet

Source§

fn default() -> LabelSet

Returns the “default value” for a type. Read more
Source§

impl<K, V, const N: usize> From<[(K, V); N]> for LabelSet
where K: Into<Cow<'static, str>>, V: Into<Cow<'static, str>>,

Source§

fn from(arr: [(K, V); N]) -> Self

Converts to this type from the input type.
Source§

impl<K, V> FromIterator<(K, V)> for LabelSet
where K: Into<Cow<'static, str>>, V: Into<Cow<'static, str>>,

Source§

fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self

Creates a value from an iterator. Read more
Source§

impl Hash for LabelSet

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for LabelSet

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for LabelSet

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for LabelSet

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Eq for LabelSet

Source§

impl StructuralPartialEq for LabelSet

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.