Struct PrometheusInstance 

pub struct PrometheusInstance<'a, N, ValueSet>
where
    N: Num + Display + Debug,
{ /* private fields */ }

Implementations

impl<'a, N> PrometheusInstance<'a, N, MissingValue>

where N: Num + Display + Debug,

pub fn new() -> Self

impl<'a, N, ValueSet> PrometheusInstance<'a, N, ValueSet>

where N: Num + Display + Debug,

pub fn with_label<L, V>(self, l: L, v: V) -> Self

where L: Into<&'a str>, V: Into<&'a str>,

pub fn with_timestamp(self, timestamp: u128) -> Self

Adds the optional timestamp to the instance.

Example:

use prometheus_exporter_base::prelude::*;

PrometheusInstance::new()
    .with_timestamp(123)
    .with_value(123);

pub fn with_current_timestamp(self) -> Result<Self, SystemTimeError>

Adds the current timestamp to the instance. The timestamp is calculated as milliseconds from the current UNIX_EPOCH as per specification. Example:

use prometheus_exporter_base::prelude::*;

PrometheusInstance::new()
    .with_current_timestamp()
    .expect("failed to get the UNIX epoch")
    .with_value(123);

pub fn with_value(self, value: N) -> PrometheusInstance<'a, N, Yes>

Adds the current value to the instance. The value will be formatted as float as per specification.

Example:

use prometheus_exporter_base::prelude::*;

PrometheusInstance::new()
    .with_value(123);

Trait Implementations

impl<'a, N, ValueSet: Clone> Clone for PrometheusInstance<'a, N, ValueSet>

where N: Num + Display + Debug + Clone,

fn clone(&self) -> PrometheusInstance<'a, N, ValueSet>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, N, ValueSet: Debug> Debug for PrometheusInstance<'a, N, ValueSet>

where N: Num + Display + Debug + Debug,

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

Formats the value using the given formatter.

impl<'a, N> Default for PrometheusInstance<'a, N, MissingValue>

where N: Num + Display + Debug,

fn default() -> Self

Returns the “default value” for a type.

impl<'a, N> RenderToPrometheus for PrometheusInstance<'a, N, Yes>

where N: Num + Display + Debug,

fn render(&self) -> String

Render must return the instance formatted string without the metric info.