Struct Rule 

pub struct Rule {
    pub name: String,
    pub when: Condition,
    pub then: Vec<Action>,
    pub otherwise: Vec<Action>,
}

One rule: a condition over a topic, and what to do as it sets and clears.

{
  "name": "water-when-dry",
  "when": { "topic": "garden/bed-1/moisture", "below": 30.0, "hysteresis": 5.0 },
  "then": [ { "drive": "bed-valve", "on": true } ],
  "otherwise": [ { "drive": "bed-valve", "on": false } ]
}

then runs once when the condition becomes true and otherwise once when it stops holding; either may be left out. The name is what the engine reports when the rule fires.

Fields

name: String

A stable name for the rule, such as "water-when-dry".

when: Condition

The condition the rule watches.

then: Vec<Action>

What to do the moment the condition becomes true.

otherwise: Vec<Action>

What to do the moment the condition stops holding.

Implementations

impl Rule

pub fn new(name: impl Into<String>, when: Condition) -> Self

Starts a rule with a name and a condition and nothing to do yet.

Arguments

• name - a stable name for the rule.
• when - the condition it watches.

Returns

The rule, for chaining.

pub fn then(self, action: Action) -> Self

Adds an action for the moment the condition becomes true.

Arguments

• action - what to do.

Returns

The rule, for chaining.

pub fn otherwise(self, action: Action) -> Self

Adds an action for the moment the condition stops holding.

Arguments

• action - what to do.

Returns

The rule, for chaining.

pub fn actuators(&self) -> impl Iterator<Item = &str>

Names every actuator the rule drives.

Returns

Each actuator name, once, in name order.

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Rule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Rule

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Rule

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 Rule