Struct MetricEntry

pub struct MetricEntry { /* private fields */ }

A statically declared metric entry.

Implementations

impl MetricEntry

pub fn metric(&self) -> &dyn Metric

Get a reference to the metric that this entry corresponds to.

pub fn name(&self) -> &str

Get the name of this metric.

pub fn description(&self) -> Option<&str>

Get the description of this metric.

pub fn metadata(&self) -> &Metadata

Access the Metadata associated with this metrics entry.

pub fn formatted(&self, format: Format) -> String

Format the metric into a string with the given format.

pub fn is(&self, metric: &dyn Metric) -> bool

Checks whether metric is the metric for this entry.

This checks both the type id and the address. Note that it may have false positives if metric is a ZST since multiple ZSTs may share the same address.

pub fn request_value<T>(&self) -> Option<T>

where T: 'static,

Request a value of type T from the metric.

This will succeed if the metric’s provide implementation called Request::provide_value with a value of type T.

pub fn request_ref<T>(&self) -> Option<&T>

where T: ?Sized + 'static,

Request a reference of type T from the metric.

This will succeed if the metric’s provide implementation called Request::provide_ref with a value of type T.

Trait Implementations

impl Debug for MetricEntry

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

Formats the value using the given formatter.

impl Deref for MetricEntry

type Target = dyn Metric

The resulting type after dereferencing.

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

Dereferences the value.

impl Send for MetricEntry

impl Sync for MetricEntry