ashv2 1.2.2

Implementation of the Asynchronous Serial Host (ASH) protocol by Silicon Labs.
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

//! Transmitted frame with metadata.

use core::time::Duration;
use std::fmt::Display;
use std::io::{Error, ErrorKind};
use std::time::Instant;

use crate::frame::Data;
use crate::transceiver::constants::ACK_TIMEOUTS;
use crate::utils::WrappingU3;

/// A transmitted frame with metadata.
#[derive(Debug)]
pub struct Transmission {
    sent: Instant,
    data: Data,
    transmits: usize,
}

impl Transmission {
    #[must_use]
    pub const fn frame_num(&self) -> WrappingU3 {
        self.data.frame_num()
    }

    pub fn elapsed(&self) -> Duration {
        self.sent.elapsed()
    }

    #[must_use]
    pub fn is_timed_out(&self, threshold: Duration) -> bool {
        self.elapsed() > threshold
    }

    pub fn data_for_transmit(&mut self) -> std::io::Result<&Data> {
        self.transmits += 1;

        if self.transmits > 1 {
            self.data.set_is_retransmission(true);
        }

        if self.transmits >= ACK_TIMEOUTS {
            return Err(Error::new(
                ErrorKind::TimedOut,
                format!(
                    "Retransmission limit of frame #{} exceeded.",
                    self.data.frame_num()
                ),
            ));
        }

        Ok(&self.data)
    }
}

impl Display for Transmission {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.data.fmt(f)
    }
}

impl From<Data> for Transmission {
    fn from(data: Data) -> Self {
        Self {
            sent: Instant::now(),
            data,
            transmits: 0,
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::frame::Data;
    use crate::transceiver::transmission::Transmission;
    use crate::utils::WrappingU3;

    #[test]
    fn test_new() {
        let data = Data::new(
            WrappingU3::default(),
            heapless::Vec::new(),
            WrappingU3::default(),
        );
        let transmission: Transmission = data.into();
        assert_eq!(transmission.transmits, 0);
        assert!(!transmission.data.is_retransmission());
    }

    #[test]
    fn test_transmit() {
        let data = Data::new(
            WrappingU3::default(),
            heapless::Vec::new(),
            WrappingU3::default(),
        );
        let mut transmission: Transmission = data.into();
        let data = transmission.data_for_transmit().unwrap();
        assert!(!data.is_retransmission());
        assert_eq!(transmission.transmits, 1);
    }

    #[test]
    fn test_retransmit() {
        let data = Data::new(
            WrappingU3::default(),
            heapless::Vec::new(),
            WrappingU3::default(),
        );
        let mut transmission: Transmission = data.into();
        let _transmit = transmission.data_for_transmit().unwrap();
        let retransmit = transmission.data_for_transmit().unwrap();
        assert!(retransmit.is_retransmission());
        assert_eq!(transmission.transmits, 2);
    }
}