airlock 0.0.8

no_std async communication
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126

/// Limit reached.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "thiserror", derive(thiserror::Error))]
#[cfg_attr(feature = "thiserror", error("Limit reached"))]
pub struct LimitReached;

/// Error performing non-blocking send.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "thiserror", derive(thiserror::Error))]
pub enum SendErrorNoWait<T> {
    /// The channel is full.
    #[cfg_attr(feature = "thiserror", error("Full"))]
    Full(T),

    /// The channel is closed.
    #[cfg_attr(feature = "thiserror", error("Closed"))]
    Closed(T),
}

/// Error performing blocking send.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "thiserror", derive(thiserror::Error))]
pub enum SendError<T> {
    /// The channel is closed
    #[cfg_attr(feature = "thiserror", error("Closed"))]
    Closed(T),
}

/// Error performing non-blocking recv.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "thiserror", derive(thiserror::Error))]
pub enum RecvErrorNoWait {
    /// The channel is empty.
    #[cfg_attr(feature = "thiserror", error("Empty"))]
    Empty,

    /// The channel is closed.
    #[cfg_attr(feature = "thiserror", error("Full"))]
    Closed,
}

/// Error performing blocking recv.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "thiserror", derive(thiserror::Error))]
pub enum RecvError {
    /// The channel is closed.
    #[cfg_attr(feature = "thiserror", error("Full"))]
    Closed,
}

impl<T> SendErrorNoWait<T> {
    /// Constructs [`SendErrorNoWait::Full`]
    pub fn full(value: T) -> Self {
        Self::Full(value)
    }

    /// Constructs [`SendErrorNoWait::Closed`]
    pub fn closed(value: T) -> Self {
        Self::Closed(value)
    }

    /// Check whether is [`SendErrorNoWait::Full`]
    pub fn is_full(&self) -> bool {
        matches!(self, Self::Full { .. })
    }

    /// Check whether is [`SendErrorNoWait::Closed`]
    pub fn is_closed(&self) -> bool {
        matches!(self, Self::Closed { .. })
    }
}

impl RecvErrorNoWait {
    /// Constructs [`RecvErrorNoWait::Empty`]
    pub fn empty() -> Self {
        Self::Empty
    }

    /// Constructs [`RecvErrorNoWait::Closed`]
    pub fn closed() -> Self {
        Self::Closed
    }

    /// Check whether is [`RecvErrorNoWait::Empty`]
    pub fn is_empty(&self) -> bool {
        matches!(self, Self::Empty { .. })
    }

    /// Check whether is [`RecvErrorNoWait::Closed`]
    pub fn is_closed(&self) -> bool {
        matches!(self, Self::Closed { .. })
    }
}

impl<T> SendError<T> {
    /// Constructs [`SendError::Closed`]
    pub fn closed(value: T) -> Self {
        Self::Closed(value)
    }

    /// Check whether is [`SendError::Closed`]
    pub fn is_closed(&self) -> bool {
        matches!(self, Self::Closed { .. })
    }
}

impl RecvError {
    /// Constructs [`RecvError::Closed`]
    pub fn closed() -> Self {
        Self::Closed
    }

    /// Check whether is [`RecvError::Closed`]
    pub fn is_closed(&self) -> bool {
        matches!(self, Self::Closed { .. })
    }
}

impl<T> SendErrorNoWait<T> {
    pub(crate) fn map_value<V>(self, value: V) -> SendErrorNoWait<V> {
        match self {
            Self::Closed { .. } => SendErrorNoWait::Closed(value),
            Self::Full { .. } => SendErrorNoWait::Full(value),
        }
    }
}