Struct metrix::instruments::Counter

pub struct Counter { /* fields omitted */ }

A simple ever increasing counter

Reacts to the following Observations:

• Observation::Observed(Update::Observations)
• Obervation::ObservedOne(Update::Observation)
• Obervation::ObservedOneValue(Update::ObservationWithValue)

Example

use std::time::Instant;
use metrix::instruments::*;

let mut counter = Counter::new_with_defaults("example");
let update = Update::Observation(Instant::now());
counter.update(&update);

assert_eq!(1, counter.get());

Methods

impl Counter

pub fn new<T: Into<String>>(name: T) -> Counter

pub fn new_with_defaults<T: Into<String>>(name: T) -> Counter

pub fn get_name(&self) -> &str

pub fn set_name<T: Into<String>>(&mut self, name: T)

pub fn name<T: Into<String>>(self, name: T) -> Self

pub fn set_title<T: Into<String>>(&mut self, title: T)

pub fn title<T: Into<String>>(self, title: T) -> Self

pub fn set_description<T: Into<String>>(&mut self, description: T)

pub fn description<T: Into<String>>(self, description: T) -> Self

pub fn inc(&mut self)

Increase the stored value by one.

pub fn inc_by(&mut self, n: u64)

Increase the stored value by n

pub fn get(&self) -> u64

Get the current value

pub fn accept<L: Eq + Send + 'static, F: Into<LabelFilter<L>>>(
    self,
    accept: F
) -> InstrumentAdapter<L, Self>

pub fn for_label<L: Eq + Send + 'static>(
    self,
    label: L
) -> InstrumentAdapter<L, Self>

Creates an InstrumentAdapter that makes this instrument react on observations on the given label.

pub fn for_labels<L: Eq + Send + 'static>(
    self,
    labels: Vec<L>
) -> InstrumentAdapter<L, Self>

Creates an InstrumentAdapter that makes this instrument react on observations with the given labels.

If labels is empty the instrument will not react to any observations

pub fn for_all_labels<L: Eq + Send + 'static>(
    self
) -> InstrumentAdapter<L, Self>

Creates an InstrumentAdapter that makes this instrument react on all observations.

pub fn for_labels_by_predicate<L, P>(
    self,
    label_predicate: P
) -> InstrumentAdapter<L, Self> where
    L: Eq + Send + 'static,
    P: Fn(&L) -> bool + Send + 'static, 

Creates an InstrumentAdapter that makes this instrument react on observations with labels specified by the predicate.

pub fn adapter<L: Eq + Send + 'static>(self) -> InstrumentAdapter<L, Self>

Creates an InstrumentAdapter that makes this instrument to no observations.

Trait Implementations

impl Descriptive for Counter

fn title(&self) -> Option<&str>

fn description(&self) -> Option<&str>

impl Instrument for Counter

impl PutsSnapshot for Counter

fn put_snapshot(&self, into: &mut Snapshot, descriptive: bool)

Puts the current snapshot values into the given Snapshot thereby following the guidelines of PutsSnapshot.

impl Updates for Counter

fn update(&mut self, with: &Update) -> usize

Update the internal state according to the given Update.