msrt 0.1.1

Portable MSRT protocol implementation.
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
26
27
28
29
30
31
32
33

//! Lower link boundaries.

use crate::core::Result;

/// Read side of a raw byte link.
pub trait LinkRead {
    /// Attempts to read bytes from the raw link into `buf`.
    fn read(&mut self, buf: &mut [u8]) -> Result<usize>;
}

/// Write side of a raw byte link.
pub trait LinkWrite {
    /// Attempts to write bytes from `buf` to the raw link.
    fn write(&mut self, buf: &[u8]) -> Result<usize>;
}

/// Raw byte link used by the protocol engine.
///
/// Implementations may be backed by UART, USB CDC, TCP, tests, or any other byte stream.
pub trait RawLink: LinkRead + LinkWrite {}

impl<T> RawLink for T where T: LinkRead + LinkWrite {}

/// Direction requested by the engine when interacting with the lower link.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum LinkIo {
    /// Engine wants to read bytes from the lower link.
    Read,
    /// Engine wants to write bytes to the lower link.
    Write,
    /// Engine does not currently need link progress.
    Idle,
}