referrerpolicy=no-referrer-when-downgrade

Struct substrate_prometheus_endpoint::Gauge

pub struct Gauge<P>
where P: Atomic,
{ /* private fields */ }
Expand description

The underlying implementation for [Gauge] and [IntGauge].

Implementations§

§

impl<P> GenericGauge<P>
where P: Atomic,

pub fn new<S1, S2>(name: S1, help: S2) -> Result<GenericGauge<P>, Error>
where S1: Into<String>, S2: Into<String>,

Create a GenericGauge with the name and help arguments.

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

Create a GenericGauge with the opts options.

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

Set the gauge to an arbitrary value.

pub fn inc(&self)

Increase the gauge by 1.

pub fn dec(&self)

Decrease the gauge by 1.

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

Add the given value to the gauge. (The value can be negative, resulting in a decrement of the gauge.)

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

Subtract the given value from the gauge. (The value can be negative, resulting in an increment of the gauge.)

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

Return the gauge value.

Trait Implementations§

§

impl<P> Clone for GenericGauge<P>
where P: Atomic,

§

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

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
§

impl<P> Collector for GenericGauge<P>
where P: Atomic,

§

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

Return descriptors for metrics.
§

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

Collect metrics.
§

impl<P> Debug for GenericGauge<P>
where P: Debug + Atomic,

§

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

Formats the value using the given formatter. Read more
§

impl<P> Metric for GenericGauge<P>
where P: Atomic,

§

fn metric(&self) -> Metric

Return the protocol Metric.

Auto Trait Implementations§

§

impl<P> Freeze for GenericGauge<P>

§

impl<P> RefUnwindSafe for GenericGauge<P>
where P: RefUnwindSafe,

§

impl<P> Send for GenericGauge<P>

§

impl<P> Sync for GenericGauge<P>

§

impl<P> Unpin for GenericGauge<P>

§

impl<P> UnwindSafe for GenericGauge<P>
where P: RefUnwindSafe,

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§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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,

§

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>,

§

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>,

§

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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more