Struct choreographer::engine::Action

pub struct Action<R> { /* fields omitted */ }

A single behavior step

An Action is a single describable step in a sequence of events.

• Each Action consists of:
  • A Context, which contains information like the color, start time, and duration of an Action
  • A behavior, which is what the LED will do over time
  • A LoopBehavior, which describes whether the individual Action will repeat in some way

Actions are typically constructed through either the ActionBuilder or script!() macro.

Actions are not usually interacted with directly, but rather as part of a Sequence.

Example

Creating an array of Actions and setting each one to a different color:

use choreographer::colors::{RED, YELLOW, GREEN, CYAN, BLUE, MAGENTA};
use groundhog::std_timer::Timer;
type MicroTimer = Timer<1_000_000>;

let colors = [RED, YELLOW, GREEN, CYAN, BLUE, MAGENTA];
let mut actions: [Action<MicroTimer>; 6] = Default::default();

for (action, color) in actions.iter_mut().zip(colors.iter()) {
    *action = ActionBuilder::new().once().seek().color(*color).for_ms(100).finish();
}

Implementations

impl<R> Action<R> where
    R: RollingTimer<Tick = u32> + Default + Clone, 

pub fn build() -> ActionBuilder<R>

Return an ActionBuilder structure to configure a new Action

Trait Implementations

impl<R: Clone> Clone for Action<R>

fn clone(&self) -> Action<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R> Default for Action<R> where
    R: RollingTimer<Tick = u32> + Default + Clone, 

fn default() -> Self

Returns the “default value” for a type.

impl<R> Deref for Action<R> where
    R: RollingTimer<Tick = u32> + Default + Clone, 

type Target = Context<R>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.