Struct WorkloopArming 

pub struct WorkloopArming { /* private fields */ }

How a workloop is armed (R2.4): every <duration> (cadence) and/or on <signal> (triggered), one construct family. A loop with neither is a declaration error, refused by the constructors.

Implementations

impl WorkloopArming

pub fn every(period: Duration) -> Result<Self, WorkloopSpecError>

Cadence-armed loop: the engine fires every period (R4.3).

Errors

Refuses a zero period (WorkloopSpecError::ZeroCadencePeriod).

pub fn every_with_signals( period: Duration, signals: Vec<String>, ) -> Result<Self, WorkloopSpecError>

Cadence-armed loop that additionally fires on the named signals.

Errors

Refuses a zero period or an empty signal name.

pub fn signal_only(signals: Vec<String>) -> Result<Self, WorkloopSpecError>

Signal-only loop: fires on signal arrival, with no cadence window for the engine to miss. The R2.4a cross-rule applies: every invariant on a signal-only loop must declare the duration-form tolerance (enforced by WorkloopSpec::new).

Errors

Refuses an empty signal list or an empty signal name.

pub const fn cadence_period(&self) -> Option<Duration>

The declared cadence period, when the loop is cadence-armed.

pub fn signals(&self) -> &[String]

The declared triggering signals (empty for a pure-cadence loop).

pub const fn is_signal_only(&self) -> bool

Whether this loop has no cadence window (signal-only arming).

Trait Implementations

impl Clone for WorkloopArming

fn clone(&self) -> WorkloopArming

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkloopArming

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WorkloopArming

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for WorkloopArming

impl PartialEq for WorkloopArming

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for WorkloopArming

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WorkloopArming