ashv2 9.0.1

Implementation of the Asynchronous Serial Host (ASH) protocol.
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

//! Acknowledgement (`ACK`) frame header.

use bitflags::bitflags;

use crate::seq::Seq;

/// Acknowledgement (`ACK`) frame header.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct Header(u8);

bitflags! {
    impl Header: u8 {
        /// The default ACK header.
        const DEFAULT = 0b1000_0000;

        /// The `nRDY` flag.
        const NOT_READY = 0b0000_1000;

        /// The acknowledgement number mask.
        const ACK_NUM = 0b0000_0111;
    }
}

impl Header {
    /// Creates a new ACK header.
    #[must_use]
    pub const fn new(ack_num: Seq, n_rdy: bool) -> Self {
        let mut raw = Self::DEFAULT.bits() | Self::ACK_NUM.bits() & ack_num.as_u8();

        if n_rdy {
            raw |= Self::NOT_READY.bits();
        }

        Self(raw)
    }

    /// Returns the ACK number.
    #[must_use]
    pub fn ack_num(self) -> Seq {
        Seq::try_from(self.bits() & Self::ACK_NUM.bits()).expect("Seq always fits.")
    }
}

#[cfg(test)]
mod tests {
    use super::Header;
    use crate::seq::Seq;

    #[test]
    fn test_new() {
        let ack = Header::new(Seq::try_from(3).expect("Seq fits."), false);
        assert_eq!(ack.ack_num().as_u8(), 3);
        assert!(!ack.contains(Header::NOT_READY));
    }

    #[test]
    fn test_new_nrdy() {
        let ack = Header::new(Seq::try_from(3).expect("Seq fits."), true);
        assert_eq!(ack.ack_num().as_u8(), 3);
        assert!(ack.contains(Header::NOT_READY));
    }
}