Struct TimedSignal

pub struct TimedSignal { /* private fields */ }

Signal state and scheduled tick action.

Implementations

impl TimedSignal

pub fn new() -> Self

Return a new instance.

pub fn update(&mut self, tick: u64) -> bool

Update internals and return state. When an action is scheduled and tick reaches the specific value for that action, the state is updated accordingly.

pub fn state(&self) -> bool

Return current state.

pub fn set_inverted(&mut self, inverted: bool)

Set inverted state on/off.

pub fn is_inverted(&self) -> bool

Return if state is inverted.

pub fn set(&mut self, state: bool)

Set state according to a boolean value.

pub fn on(&mut self)

Set on state.

pub fn off(&mut self)

Set off state.

pub fn toggle(&mut self)

Toggle state.

pub fn blink(&mut self, period: u32)

Toggle state at a predefined rate with a 50% ratio. period is the number of ticks for one period. E.g. if set to 4, the state will be on for 2 ticks and off for another 2 ticks.

pub fn set_at(&mut self, trigger_tick: u64, state: bool)

Set a state when a tick is reached.

pub fn set_until(&mut self, trigger_tick: u64, state: bool)

Set a state until a tick is reached, then return to previous state.

pub fn set_for(&mut self, duration_ticks: u64, state: bool)

Set a state for a number of ticks, then invert it. Single trigger.

pub fn set_for_retrigger(&mut self, duration_ticks: u64, state: bool)

Set a state for a number of ticks, then invert it. Retrigger.

pub fn on_at(&mut self, trigger_tick: u64)

Set on state when a tick is reached.

pub fn on_until(&mut self, trigger_tick: u64)

Set on state until a tick is reached, then set it off.

pub fn on_for(&mut self, duration_ticks: u64)

Set on state for a number of ticks, then set it off.

pub fn off_at(&mut self, trigger_tick: u64)

Set off state when a tick is reached.

pub fn off_until(&mut self, trigger_tick: u64)

Set off state until a tick is reached, then set it on.

pub fn off_for(&mut self, duration_ticks: u64)

Set off state for a number of ticks, then set it on.

pub fn toggle_at(&mut self, trigger_tick: u64)

Toggle state when a tick is reached.

pub fn toggle_until(&mut self, trigger_tick: u64)

Toggle state until a tick is reached, then return to previous state.

pub fn toggle_for(&mut self, duration_ticks: u64)

Toggle state for a number of ticks, then return to previous state. Single trigger.

pub fn toggle_for_retrigger(&mut self, duration_ticks: u64)

Toggle state for a number of ticks, then return to previous state. Retrigger.

Trait Implementations

impl Clone for TimedSignal

fn clone(&self) -> TimedSignal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimedSignal

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

Formats the value using the given formatter.

impl Default for TimedSignal

fn default() -> TimedSignal

Returns the “default value” for a type.

impl PartialEq for TimedSignal

fn eq(&self, other: &TimedSignal) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TimedSignal

impl StructuralPartialEq for TimedSignal