Struct rillrate::GaugeProvider

pub struct GaugeProvider { /* fields omitted */ }

Sends metrics as gauge that can change value to any.

Implementations

impl GaugeProvider

pub fn new(path: Path) -> GaugeProvider

Creates a new Gauge provider.

pub fn inc(&self, delta: f64, timestamp: Option<SystemTime>)

Increments the value by the specific delta.

pub fn dec(&self, delta: f64, timestamp: Option<SystemTime>)

Decrements the value by the specific delta.

pub fn set(&self, new_value: f64, timestamp: Option<SystemTime>)

Set the value.

Methods from Deref<Target = Provider>

pub fn path(&self) -> &Path

Returns a reference to a Path of the Provider.

pub fn is_active(&self) -> bool

Returns true is the Provider has to send data.

pub async fn when_activated(&'_ mut self) -> Result<(), Error>

Use this method to detect when stream had activated.

It's useful if you want to spawn async coroutine that can read a batch of data, but will wait when some streams will be activated to avoid resources wasting.

When the generating coroutine active you can use is_active method to detect when to change it to awaiting state again.

Trait Implementations

impl Debug for GaugeProvider

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

Formats the value using the given formatter.

impl Deref for GaugeProvider

type Target = ProtectedProvider<f64>

The resulting type after dereferencing.

pub fn deref(&self) -> &<GaugeProvider as Deref>::Target

Dereferences the value.

impl DerefMut for GaugeProvider

pub fn deref_mut(&mut self) -> &mut <GaugeProvider as Deref>::Target

Mutably dereferences the value.