autd3-rs-core 0.9.0

Core types and link abstraction shared across the AUTD3 phased-array sdk crates.
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

use thiserror::Error;

type BoxError = Box<dyn core::error::Error + Send + Sync>;

#[derive(Debug, Error)]
#[error("{message}")]
pub struct LinkError {
    message: String,
    #[source]
    source: Option<BoxError>,
}

impl LinkError {
    #[must_use]
    pub fn new(message: impl Into<String>) -> Self {
        Self {
            message: message.into(),
            source: None,
        }
    }

    #[must_use]
    pub fn with_source(message: impl Into<String>, source: impl Into<BoxError>) -> Self {
        Self {
            message: message.into(),
            source: Some(source.into()),
        }
    }

    #[must_use]
    pub fn message(&self) -> &str {
        &self.message
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Error)]
#[non_exhaustive]
pub enum EncodeError {
    #[error("focus coordinate {axis} = {value} out of range {min}..={max}")]
    FocusOutOfRange {
        axis: &'static str,
        value: i32,
        min: i32,
        max: i32,
    },

    #[error("transition margin {0:?} is out of range (0..=4294967295 ns)")]
    TransitionMarginOutOfRange(core::time::Duration),

    #[error(
        "transition mode `Later` only writes a bank without transitioning, so it cannot be encoded into a transition"
    )]
    TransitionLaterNotEncodable,
}