Rack

Struct Rack 

Source
pub struct Rack { /* private fields */ }
Expand description

State of the process or a group of logic lines. Acts as a factory for Processor instances. Shares recording state with the created processors.

Implementations§

Source§

impl Rack

Source

pub fn new() -> Self

Creates a new state

Examples found in repository?
examples/fan_control.rs (line 4)
3fn main() {
4    let mut state = Rack::new().with_recording_enabled();
5    let mut processor = state.processor();
6
7    // Some fan state
8    let mut fan = false;
9
10    // A temperature sensor value
11    let temperature = 31.0;
12
13    processor
14        // a sequence to turn on the fan on if the temperature is above 30 degrees
15        .line("fan_on", temperature)
16        .then(action!("temp_high", |t| (t > 30.0).then_some(())))
17        .then(action!("fan_on", |()| {
18            fan = true;
19            Some(())
20        }));
21    processor
22        // a sequence to turn off the fan if the temperature is below 25 degrees
23        .line("fan_off", temperature)
24        .then(action!("temp_low", |t| (t < 25.0).then_some(())))
25        .then(action!("fan_off", |()| {
26            fan = false;
27            Some(())
28        }));
29
30    state.ingress(&mut processor);
31    println!("{}", state);
32
33    println!("{}", serde_json::to_string_pretty(&state).unwrap());
34}
Source

pub fn ingress(&mut self, processor: &mut Processor)

Record the state of the lines and reset the processor

Examples found in repository?
examples/fan_control.rs (line 30)
3fn main() {
4    let mut state = Rack::new().with_recording_enabled();
5    let mut processor = state.processor();
6
7    // Some fan state
8    let mut fan = false;
9
10    // A temperature sensor value
11    let temperature = 31.0;
12
13    processor
14        // a sequence to turn on the fan on if the temperature is above 30 degrees
15        .line("fan_on", temperature)
16        .then(action!("temp_high", |t| (t > 30.0).then_some(())))
17        .then(action!("fan_on", |()| {
18            fan = true;
19            Some(())
20        }));
21    processor
22        // a sequence to turn off the fan if the temperature is below 25 degrees
23        .line("fan_off", temperature)
24        .then(action!("temp_low", |t| (t < 25.0).then_some(())))
25        .then(action!("fan_off", |()| {
26            fan = false;
27            Some(())
28        }));
29
30    state.ingress(&mut processor);
31    println!("{}", state);
32
33    println!("{}", serde_json::to_string_pretty(&state).unwrap());
34}
Source

pub fn line_state(&self, name: &str) -> Option<&LineState>

Returns the state of the line

Source

pub fn lines(&self) -> &BTreeMap<Cow<'static, str>, LineState>

Returns all states of the lines

Source

pub fn snapshot(&self) -> Snapshot

Creates a snapshot of the current state of the lines

Source

pub fn snapshot_filtered<P>(&self, predicate: P) -> Snapshot
where P: Fn(&LineState) -> bool,

Creates a filtered snapshot of the current state of the lines

Source

pub fn processor(&self) -> Processor

Creates a new processor

Examples found in repository?
examples/fan_control.rs (line 5)
3fn main() {
4    let mut state = Rack::new().with_recording_enabled();
5    let mut processor = state.processor();
6
7    // Some fan state
8    let mut fan = false;
9
10    // A temperature sensor value
11    let temperature = 31.0;
12
13    processor
14        // a sequence to turn on the fan on if the temperature is above 30 degrees
15        .line("fan_on", temperature)
16        .then(action!("temp_high", |t| (t > 30.0).then_some(())))
17        .then(action!("fan_on", |()| {
18            fan = true;
19            Some(())
20        }));
21    processor
22        // a sequence to turn off the fan if the temperature is below 25 degrees
23        .line("fan_off", temperature)
24        .then(action!("temp_low", |t| (t < 25.0).then_some(())))
25        .then(action!("fan_off", |()| {
26            fan = false;
27            Some(())
28        }));
29
30    state.ingress(&mut processor);
31    println!("{}", state);
32
33    println!("{}", serde_json::to_string_pretty(&state).unwrap());
34}
Source

pub fn with_recording_enabled(self) -> Self

Enables recording for the state

Examples found in repository?
examples/fan_control.rs (line 4)
3fn main() {
4    let mut state = Rack::new().with_recording_enabled();
5    let mut processor = state.processor();
6
7    // Some fan state
8    let mut fan = false;
9
10    // A temperature sensor value
11    let temperature = 31.0;
12
13    processor
14        // a sequence to turn on the fan on if the temperature is above 30 degrees
15        .line("fan_on", temperature)
16        .then(action!("temp_high", |t| (t > 30.0).then_some(())))
17        .then(action!("fan_on", |()| {
18            fan = true;
19            Some(())
20        }));
21    processor
22        // a sequence to turn off the fan if the temperature is below 25 degrees
23        .line("fan_off", temperature)
24        .then(action!("temp_low", |t| (t < 25.0).then_some(())))
25        .then(action!("fan_off", |()| {
26            fan = false;
27            Some(())
28        }));
29
30    state.ingress(&mut processor);
31    println!("{}", state);
32
33    println!("{}", serde_json::to_string_pretty(&state).unwrap());
34}
Source

pub fn set_recording(&mut self, recording: bool)

Sets the recording state for the state

Source

pub fn is_recording(&self) -> bool

Returns true if the rack is recording

Trait Implementations§

Source§

impl Clone for Rack

Source§

fn clone(&self) -> Rack

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Rack

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Rack

Source§

fn default() -> Rack

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Rack

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for Rack

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Serialize for Rack

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Rack

§

impl RefUnwindSafe for Rack

§

impl Send for Rack

§

impl Sync for Rack

§

impl Unpin for Rack

§

impl UnwindSafe for Rack

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> StepInput for T
where T: Serialize,