autd3_driver/datagram/
with_timeout.rs

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
use std::time::Duration;

use crate::{error::AUTDDriverError, geometry::Geometry};

use super::Datagram;

use derive_more::Deref;

/// A wrapper to overwrite timeout of [`Datagram`].
#[derive(Deref, Debug)]
pub struct DatagramWithTimeout<D: Datagram> {
    #[deref]
    datagram: D,
    timeout: Option<Duration>,
}

impl<D: Datagram> Datagram for DatagramWithTimeout<D> {
    type G = D::G;

    fn operation_generator(self, geometry: &Geometry) -> Result<Self::G, AUTDDriverError> {
        self.datagram.operation_generator(geometry)
    }

    fn timeout(&self) -> Option<Duration> {
        self.timeout
    }

    fn parallel_threshold(&self) -> Option<usize> {
        self.datagram.parallel_threshold()
    }
}

/// A trait to convert [`Datagram`] to [`DatagramWithTimeout`].
pub trait IntoDatagramWithTimeout<D: Datagram> {
    /// Convert [`Datagram`] to [`DatagramWithTimeout`].
    fn with_timeout(self, timeout: Option<Duration>) -> DatagramWithTimeout<D>;
}

impl<D: Datagram> IntoDatagramWithTimeout<D> for D {
    fn with_timeout(self, timeout: Option<Duration>) -> DatagramWithTimeout<D> {
        DatagramWithTimeout {
            datagram: self,
            timeout,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    use crate::{
        datagram::tests::{NullDatagram, NullOperationGenerator},
        geometry::tests::create_geometry,
    };

    #[test]
    fn with_timeout() {
        let geometry = create_geometry(1, 249);
        let datagram = NullDatagram {
            timeout: None,
            parallel_threshold: Some(100),
        }
        .with_timeout(Some(std::time::Duration::from_secs(1)));
        assert_eq!(datagram.timeout(), Some(std::time::Duration::from_secs(1)));
        assert_eq!(datagram.parallel_threshold(), Some(100));
        let _: Result<NullOperationGenerator, _> = datagram.operation_generator(&geometry);
    }
}