Struct dipstick::Labels

pub struct Labels { /* fields omitted */ }

Base structure to carry metric labels from the application to the metric backend(s). Can carry both one-off labels and exported context labels (if async metrics are enabled). Used in applications through the labels!() macro.

Implementations

impl Labels

pub fn save_context(&mut self)

Used to save metric context before enqueuing value for async output.

pub fn lookup(&self, key: &str) -> Option<Arc<String>>

Generic label lookup function. Searches provided labels, provided scopes or default scopes.

pub fn into_map(self) -> HashMap<String, Arc<String>>

Export current state of labels to a map. Note: An iterator would still need to allocate to check for uniqueness of keys.

Trait Implementations

impl Clone for Labels

fn clone(&self) -> Labels

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Labels

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

Formats the value using the given formatter.

impl Default for Labels

fn default() -> Self

Create empty labels. Only Thread and App labels will be used for lookups.

impl From<HashMap<String, Arc<String>, RandomState>> for Labels

fn from(map: HashMap<String, Arc<String>>) -> Self

Performs the conversion.