Struct transition::Transition

pub struct Transition { /* fields omitted */ }

Main structure. Represents colors of task state (pending, successfull, failed). Allows to start the transition.

Implementations

impl Transition

pub fn new(colors: &[Led]) -> Result<Self, TransitionErr>

Creates new instance of Transition with specified colors for "pending" state.

Passed colors will be used between calls of start and notify_success (or notify_failure) to visualise pendig task execution. The failure color is set to red and the success color is set to green. You can override success and failure colors using on_success and on_failure accordingly.

Example

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

let transition = Transition::new(&[Led::Blue, Led::Blank]);

Errors

If there will be issue with connecting to blink(1) device, an error variant will be returned.

pub fn start(self) -> Result<Notifier, TransitionErr>

Starts the transition.

The transition is started in a separate thread. As a result, you get Notifier struct.

Example

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

let notifier = Transition::new(&[Led::Blue, Led::Blank])?.start()?;

Errors

If any error related to Blink(1) device will be thrown, this method results with TransitionErr.

#[must_use]pub fn on_success(self, color: &Led) -> Self

Allows to override success color.

Example

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

let transition = Transition::default().on_success(&Led::Orange);

#[must_use]pub fn on_failure(self, color: &Led) -> Self

Allows to override failure color.

Example

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

let transition = Transition::default().on_failure(&Led::Cyan);

Trait Implementations

impl Clone for Transition

fn clone(&self) -> Transition

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Transition

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

Formats the value using the given formatter.

impl Default for Transition

fn default() -> Self

Returns the "default value" for a type.