Struct transition::Notifier

pub struct Notifier { /* fields omitted */ }

Allows to control blinking of the LED after the transition starts.

After you starts the blinking via start(), you can end the blinking process via this struct.

Example

use transition::{Transition, Notifier, Led};

let notifier: Notifier = Transition::new(&[Led::Blue, Led::Blank])?.start()?;
// blinks using color blue
thread::sleep(Duration::from_secs(1));
notifier.notify_failure();

Implementations

impl Notifier

pub fn notify_success(self) -> Result<(), TransitionErr>

Finishes the transition with success.

Changes the color of the LED, to the one set with on_success. If not set, the default is set to green.

Stops the thread which is responsible for blinking of the LED.

Example

use transition::{Transition, Notifier, Led};

let notifier: Notifier = Transition::new(&[Led::Blue, Led::Blank])?.start()?;
// blinks using color blue
thread::sleep(Duration::from_secs(1));
notifier.notify_success();

Errors

This method sends message to blinking thread using crossbeam channel. If any error related with sending this message will occur, then this method returns TransitionErr.

pub fn notify_failure(self) -> Result<(), TransitionErr>

Finishes the transition with failure.

Changes the color of the LED, to the one set with on_failure. If not set, the default is set to red.

Stops the thread which is responsible for blinking of the LED.

Example

use transition::{Transition, Notifier, Led};

let notifier: Notifier = Transition::new(&[Led::Blue, Led::Blank])?.start()?;
// blinks using color blue
thread::sleep(Duration::from_secs(1));
notifier.notify_failure();

Errors

This method sends message to blinking thread using crossbeam channel. If any error related with sending this message will occur, then this method returns TransitionErr.

Trait Implementations

impl Debug for Notifier

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

Formats the value using the given formatter.