zbus-lockstep 0.7.0

Keep types in lockstep with DBus XML definitions
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

use std::path::PathBuf;

#[non_exhaustive]
#[derive(Debug)]
pub enum LockstepError {
    ArgumentNotFound(String),
    InterfaceNotFound(String),
    MemberNotFound(String),
    PropertyNotFound(String),
    PathNotFound(PathBuf),
    Env(std::env::VarError),
    Fmt(std::fmt::Error),
    Io(std::io::Error),
    Xml(zbus_xml::Error),
    Zvariant(zvariant::Error),
}

impl std::error::Error for LockstepError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            LockstepError::Env(e) => Some(e),
            LockstepError::Fmt(e) => Some(e),
            LockstepError::Io(e) => Some(e),
            LockstepError::Xml(e) => Some(e),
            LockstepError::Zvariant(e) => Some(e),
            _ => None,
        }
    }
}

impl std::fmt::Display for LockstepError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            LockstepError::ArgumentNotFound(name) => write!(f, "Argument \"{name}\" not found."),
            LockstepError::InterfaceNotFound(name) => write!(f, "Interface \"{name}\" not found."),
            LockstepError::MemberNotFound(name) => write!(f, "Member \"{name}\" not found."),
            LockstepError::PropertyNotFound(name) => write!(f, "Property \"{name}\" not found."),
            LockstepError::PathNotFound(path) => write!(
                f,
                "No XML path provided and default XML path not found. Searched directory: \"{}\"",
                path.display()
            ),
            LockstepError::Env(e) => write!(f, "Environment variable error: {e}"),
            LockstepError::Fmt(e) => write!(f, "Formatting error: {e}"),
            LockstepError::Io(e) => write!(f, "IO error: {e}"),
            LockstepError::Xml(e) => write!(f, "XML error: {e}"),
            LockstepError::Zvariant(e) => write!(f, "Zvariant signature error: {e}"),
        }
    }
}

impl From<std::io::Error> for LockstepError {
    fn from(e: std::io::Error) -> Self {
        LockstepError::Io(e)
    }
}

impl From<zbus_xml::Error> for LockstepError {
    fn from(e: zbus_xml::Error) -> Self {
        LockstepError::Xml(e)
    }
}

impl From<zvariant::Error> for LockstepError {
    fn from(e: zvariant::Error) -> Self {
        LockstepError::Zvariant(e)
    }
}

impl From<zvariant::signature::Error> for LockstepError {
    fn from(e: zvariant::signature::Error) -> Self {
        // Under-the-hood `zvariant` converts this to `zvariant::Error::SignatureParse(e)`
        LockstepError::Zvariant(zvariant::Error::from(e))
    }
}

impl From<std::env::VarError> for LockstepError {
    fn from(e: std::env::VarError) -> Self {
        LockstepError::Env(e)
    }
}

impl From<std::fmt::Error> for LockstepError {
    fn from(e: std::fmt::Error) -> Self {
        LockstepError::Fmt(e)
    }
}

// `LockstepError` wraps upstream errors (e.g. `io::Error`) that are `!UnwindSafe`
// because they may carry a `Box<dyn Error>`, which the compiler conservatively
// assumes could hide interior mutability. This propagates and strips the auto
// traits from `LockstepError`.
//
// These impls are sound: `LockstepError` is passive, owned error data with no
// interior mutability (`Cell`/`RefCell`) and no handles to shared mutable state.
// It is only ever read (e.g. via `Display`), never mutated, so a panic can never
// leave it holding a broken invariant that could be observed across a
// `catch_unwind` boundary.
impl std::panic::UnwindSafe for LockstepError {}
impl std::panic::RefUnwindSafe for LockstepError {}