MappedMetric

Struct MappedMetric 

Source
pub struct MappedMetric<H> { /* private fields */ }
Expand description

A metric that is resolved dynamically by one or more label values.

Unlike a plain metric handle, a mapped metric does not hold a single handle. Instead it holds a concurrent map from a set of dynamic label values to the corresponding registered handle. Handles are registered lazily on first use and cached for subsequent lookups.

The underlying map (and the fixed label set) is shared across clones, so every clone of the containing metrics struct observes the same cache. Lookups are lock-free once a handle has been registered.

This type is an implementation detail of the static_metrics attribute macro and is not meant to be constructed or used directly.

Implementations§

Source§

impl<H> MappedMetric<H>
where H: Clone,

Source

pub fn new(labels: Arc<Vec<Label>>) -> Self

Creates a new MappedMetric whose handles are registered with the given fixed labels.

Source

pub fn get_or_register( &self, keys: &[&'static str], values: &[SharedString], register: impl FnOnce(&[Label]) -> H, ) -> H

Returns the handle for the given dynamic label values, registering and caching it on the first lookup.

keys are the dynamic label names and values their stringified values, in the same order and of the same length. The register closure is invoked only on a cache miss and receives the full label set (the fixed labels followed by the dynamic labels) with which to register the handle.

Trait Implementations§

Source§

impl<H> Clone for MappedMetric<H>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<H> Freeze for MappedMetric<H>

§

impl<H> RefUnwindSafe for MappedMetric<H>

§

impl<H> Send for MappedMetric<H>
where H: Send + Sync,

§

impl<H> Sync for MappedMetric<H>
where H: Send + Sync,

§

impl<H> Unpin for MappedMetric<H>

§

impl<H> UnwindSafe for MappedMetric<H>

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.