jtag-scanner 0.2.0

A JTAG boundary scanning module
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

use std::{
    cell::{BorrowError, BorrowMutError},
    fmt::Display,
    panic::Location,
};

/// The error type used in this crate.
#[derive(Debug, Clone)]
pub struct Error {
    kind: ErrorKind,
    message: String,
    location: &'static Location<'static>,
}

impl Error {
    #[track_caller]
    #[allow(unused)]
    pub(crate) fn new<S: ToString>(kind: ErrorKind, message: S) -> Self {
        Error {
            kind,
            message: message.to_string(),
            location: Location::caller(),
        }
    }

    #[track_caller]
    pub(crate) fn result<T, S: ToString>(kind: ErrorKind, message: S) -> Result<T, Self> {
        Err(Error {
            kind,
            message: message.to_string(),
            location: Location::caller(),
        })
    }

    /// Returns the corresponding [`ErrorKind`] for this error.
    pub fn kind(&self) -> ErrorKind {
        self.kind
    }

    /// Returns the message for this error.
    pub fn message(&self) -> &str {
        &self.message
    }

    /// Where the error is produced in the `jtag_scanner` crate.
    pub fn location(&self) -> &'static Location<'static> {
        self.location
    }
}

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

impl std::error::Error for Error {}

/// A list of general categories of errors produced in this crate.
#[derive(Debug, Clone, Copy)]
#[non_exhaustive]
pub enum ErrorKind {
    BrokenChain,
    UsageConflict,
    WrongPinType,
    PinGroupLimit,
    Other,
}

impl From<&str> for Error {
    #[track_caller]
    fn from(value: &str) -> Self {
        Error {
            kind: ErrorKind::Other,
            message: value.to_string(),
            location: Location::caller(),
        }
    }
}

impl From<String> for Error {
    #[track_caller]
    fn from(value: String) -> Self {
        Error {
            kind: ErrorKind::Other,
            message: value,
            location: Location::caller(),
        }
    }
}

impl From<BorrowError> for Error {
    #[track_caller]
    fn from(_: BorrowError) -> Self {
        Error {
            kind: ErrorKind::UsageConflict,
            message: "scanner is being used by another pin or pin group".into(),
            location: Location::caller(),
        }
    }
}

impl From<BorrowMutError> for Error {
    #[track_caller]
    fn from(_: BorrowMutError) -> Self {
        Error {
            kind: ErrorKind::UsageConflict,
            message: "scanner is being used by another pin or pin group".into(),
            location: Location::caller(),
        }
    }
}