Struct prometrics::metrics::GaugeBuilder

pub struct GaugeBuilder { /* fields omitted */ }

Gauge builder.

Methods

impl GaugeBuilder

pub fn new(name: &str) -> Self

Makes a builder for gauges named name.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn namespace(&mut self, namespace: &str) -> &mut Self

Sets the namespace part of the metric name of this.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn subsystem(&mut self, subsystem: &str) -> &mut Self

Sets the subsystem part of the metric name of this.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn help(&mut self, help: &str) -> &mut Self

Sets the help of this.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn label(&mut self, name: &str, value: &str) -> &mut Self

Adds a label.

Note that name will be validated in the invocation of the finish method.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn registry(&mut self, registry: Registry) -> &mut Self

Adds a registry to which the resulting gauges will be registered.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn default_registry(&mut self) -> &mut Self

Adds the default registry.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn initial_value(&mut self, value: f64) -> &mut Self

Sets the initial value of resulting gauges.

pub fn finish(&self) -> Result<Gauge>

Builds a gauge.

Errors

This method will return Err(_) if any of the name of the metric or labels is malformed.

Trait Implementations

impl Debug for GaugeBuilder

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.