Struct LedEffect

pub struct LedEffect<C: Clock> { /* private fields */ }

LED Effect instance

Stores some additional metadata alongside with the effect type used during the effect processing.

Implementations

impl<C: Clock> LedEffect<C>

pub fn new(fx_type: EffectType<C::T>) -> Self

Create new LED Effect instance with the assigned effect type

pub fn has_started(&self) -> bool

Indicates whether the effect has started

pub fn started_at(&self) -> Option<Instant<C>>

Get the timestamp at which the effect started

pub fn set_started_at(&mut self, now: Instant<C>)

Sets the effect start point

This should be only called by the poll functions of [Led] implementations

pub fn get_type(&self) -> &EffectType<C::T>

Returns the effect type of this LED effect instance

pub fn get_duration(&self) -> Option<Milliseconds<C::T>>

Returns the duration for which the effect should last

pub fn set_duration(&mut self, dur: Milliseconds<C::T>)

Sets the effect duration

pub fn time_elapsed(&self, now: Instant<C>) -> Option<Milliseconds<C::T>>

Returns elapsed duration since the effect has started

pub fn current_cycle_duration( &self, now: Instant<C>, ) -> Option<Milliseconds<C::T>>

Returns the duration of current cycle

pub fn start_new_cycle(&mut self, now: Instant<C>)

Start new cycle at an timestamp

Trait Implementations

impl<C: Clone + Clock> Clone for LedEffect<C>

where C::T: Clone,

fn clone(&self) -> LedEffect<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug + Clock> Debug for LedEffect<C>

where C::T: Debug,

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

Formats the value using the given formatter.

impl<C: Copy + Clock> Copy for LedEffect<C>

where C::T: Copy,