Struct substrate_prometheus_endpoint::Counter

pub struct Counter<P>
where
    P: Atomic,
{ /* private fields */ }

The underlying implementation for [Counter] and [IntCounter].

Implementations

impl<P> GenericCounter<P>

where P: Atomic,

pub fn new<S1, S2>(name: S1, help: S2) -> Result<GenericCounter<P>, Error>

where S1: Into<String>, S2: Into<String>,

Create a GenericCounter with the name and help arguments.

pub fn with_opts(opts: Opts) -> Result<GenericCounter<P>, Error>

Create a GenericCounter with the opts options.

pub fn inc_by(&self, v: <P as Atomic>::T)

Increase the given value to the counter.

Panics

Panics in debug build if the value is < 0.

pub fn inc(&self)

Increase the counter by 1.

pub fn get(&self) -> <P as Atomic>::T

Return the counter value.

pub fn reset(&self)

Restart the counter, resetting its value back to 0.

pub fn local(&self) -> GenericLocalCounter<P>

Return a [GenericLocalCounter] for single thread usage.

Trait Implementations

impl<P> Clone for GenericCounter<P>

where P: Atomic,

fn clone(&self) -> GenericCounter<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P> Collector for GenericCounter<P>

where P: Atomic,

fn desc(&self) -> Vec<&Desc>

Return descriptors for metrics.

fn collect(&self) -> Vec<MetricFamily>

Collect metrics.

impl<P> Debug for GenericCounter<P>

where P: Debug + Atomic,

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

Formats the value using the given formatter.

impl<P> Metric for GenericCounter<P>

where P: Atomic,

fn metric(&self) -> Metric

Return the protocol Metric.