logic-mesh 1.0.0

Control logic engine using event based and reactive blocks written in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

// Copyright (c) 2022-2023, Radu Racariu.

use crate::base::block::Block;
use std::time::Duration;

/// Specifies the protocol for reading
/// block inputs
#[allow(async_fn_in_trait)]
pub trait InputReader: Block {
    /// Reads the connected block inputs.
    ///
    /// # Returns
    /// The index of the input that received a value.
    async fn read_inputs(&mut self) -> Option<usize>;

    /// Reads the connected block inputs.
    /// This would only complete when at least one input has data.
    ///
    /// # Returns
    /// The index of the input that received a value.
    async fn read_inputs_until_ready(&mut self) -> Option<usize>;

    /// Waits for any input to have data.
    async fn wait_on_inputs(&mut self, timeout: Duration) -> Option<usize>;
}