autd3-core 38.1.0

AUTD3 core traits and types
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

use crate::firmware::SamplingConfigError;

#[derive(Debug, PartialEq, Clone)]
/// An error occurred during modulation calculation.
pub struct ModulationError {
    msg: String,
}

impl core::fmt::Display for ModulationError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "{}", self.msg)
    }
}

impl core::error::Error for ModulationError {}

impl ModulationError {
    /// Creates a new [`ModulationError`].
    #[must_use]
    pub fn new(msg: impl ToString) -> Self {
        Self {
            msg: msg.to_string(),
        }
    }
}

impl From<SamplingConfigError> for ModulationError {
    fn from(e: SamplingConfigError) -> Self {
        Self::new(e)
    }
}

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

    #[test]
    fn display() {
        let err = ModulationError::new("test error");
        assert_eq!(format!("{}", err), "test error");
    }

    #[test]
    fn from_sampling_config_error() {
        let sce = SamplingConfigError::FreqInvalid(1 * crate::common::Hz);
        let me: ModulationError = sce.into();
        assert_eq!(me.msg, sce.to_string());
    }
}