Struct metrix::instruments::switches::StaircaseTimer

pub struct StaircaseTimer { /* fields omitted */ }

A StaircaseTimer is 'tapped' by an Observation and then stays on for some time.

The StaircaseTimer works exactly like a switch in a staircase: You press the switch and the light will stay on for some time. Here it is an Observation that pushes the switch and the light is a boolean that will be set to true for some time. When triggered while already on, the time being true will be prolonged.

The state written to a Snapshot can be inverted.

Methods

impl StaircaseTimer

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

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

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 set_invert(&mut self, invert: bool)

Set whether the current value should be inverted in a snapshot or not

Default is false

pub fn enable_invert(&mut self)

The current value should be inverted in a snapshot

Same as self.set_invert(true);

pub fn invert(&self) -> bool

return whether invert is on or off

pub fn set_switch_off_after(&mut self, d: Duration)

Sets duration after which the internal state switches back to false

Default is 60 seconds

pub fn switch_off_after(self, d: Duration) -> Self

Sets duration after which the internal state switches back to false

Default is 60 seconds

pub fn get_switch_off_after(&self) -> Duration

Gets duration after which the internal state switches back to false

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 for_label<L: Eq>(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>(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>(self) -> InstrumentAdapter<L, Self>

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

pub fn adapter<L: Eq>(self) -> InstrumentAdapter<L, Self>

Creates an InstrumentAdapter that makes this instrument to no observations.

pub fn state(&self) -> bool

Returns the current state

Trait Implementations

impl Updates for StaircaseTimer

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

Update the internal state according to the given Update.

impl Instrument for StaircaseTimer

impl Descriptive for StaircaseTimer

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

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

impl PutsSnapshot for StaircaseTimer

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

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