metrics

Struct Metadata

Source
pub struct Metadata<'a> { /* private fields */ }
Expand description

Metadata describing a metric.

All metrics have the following metadata:

  • A target, a string that categorizes part of the system where metric originates from. The `metrics`` macros default to using the module path where the metric originate as the target, but it may be overridden.
  • A level, specifying the verbosity the metric is emitted at.

In addition, the following optional metadata describing the source code location where the metric originated from may be provided:

  • The module path of the source code location where the metric event originated.

Metadata usage is exporter-specific, and may be ignored entirely. See the documentation of the specific exporter being used for more information.

Implementations§

Source§

impl<'a> Metadata<'a>

Source

pub const fn new( target: &'a str, level: Level, module_path: Option<&'a str>, ) -> Self

Constructs a new Metadata.

Source

pub fn level(&self) -> &Level

Returns the verbosity level of the metric.

Source

pub fn target(&self) -> &'a str

Returns the target of the metric.

This specifies the part of the system where the metric originates from. Typically, this is the module path where the metric originated from, but can be overridden when registering a metric.

Source

pub fn module_path(&self) -> Option<&'a str>

Returns the module path of the metric.

This specifies the module where the metric originates from, or None if the module path is unknown.

Trait Implementations§

Source§

impl<'a> Clone for Metadata<'a>

Source§

fn clone(&self) -> Metadata<'a>

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

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for Metadata<'a>

Source§

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

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

impl<'a> PartialEq for Metadata<'a>

Source§

fn eq(&self, other: &Metadata<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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<'a> Eq for Metadata<'a>

Source§

impl<'a> StructuralPartialEq for Metadata<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Metadata<'a>

§

impl<'a> RefUnwindSafe for Metadata<'a>

§

impl<'a> Send for Metadata<'a>

§

impl<'a> Sync for Metadata<'a>

§

impl<'a> Unpin for Metadata<'a>

§

impl<'a> UnwindSafe for Metadata<'a>

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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.