Struct metrix::instruments::switches::Flag

pub struct Flag { /* fields omitted */ }

A Flag which can have the states true or false

The Flag reacts on observations with values. A value of 0 sets the Flag to false, '1' will set the Flag to true. For all other values the behaviour is undefined.

Methods

impl Flag

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

pub fn new_with_state<T: Into<String>>(name: T, initial_state: bool) -> Self

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 state(self, initial_state: bool) -> Self

pub fn set_show_inverted(&mut self, name_alternation: NameAlternation)

Show the inverted value. Name will be adjusted with name_alternation.

pub fn show_inverted(self, name_alternation: NameAlternation) -> Self

Show the inverted value. Name will be adjusted with name_alternation.

pub fn set_show_inverted_prefixed<T: Into<String>>(&mut self, prefix: T)

Show the inverted value. Name will be prefixed with prefix.

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

Show the inverted value. Name will be prefixed with prefix.

pub fn set_show_inverted_postfixed<T: Into<String>>(&mut self, postfix: T)

Show the inverted value. Name will be postfixed with postfix.

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

Show the inverted value. Name will be postfixed with postfix.

pub fn set_show_inverted_renamed<T: Into<String>>(&mut self, new_name: T)

Show the inverted value. Name will be renamed with new_name.

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

Show the inverted value. Name will be renamed with new_name.

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.

pub fn get_state(&self) -> Option<bool>

Returns the current state

Trait Implementations

impl Descriptive for Flag

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

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

impl Instrument for Flag

impl PutsSnapshot for Flag

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 Flag

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

Update the internal state according to the given Update.