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_with_defaults<T: Into<String>>(
    name: T,
    initial_state: Option<bool>
) -> Self

pub fn name(&self) -> &str

Gets the name of this Flag

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

Set the name if this Flag.

The name is a path segment within a Snapshot

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

Sets the title of this Flag.

A title can be part of a descriptive Snapshot

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

Sets the description of this Flag.

A description can be part of a descriptive Snapshot

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

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

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

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

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

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

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

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

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

Returns the current state

Trait Implementations

impl Updates for Flag

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

Update the internal state according to the given Update.

impl Instrument for Flag

impl Descriptive for Flag

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

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

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.