way 0.0.0-beta1

Fast Async Channel With no-std Support and Alternative Sync API
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

#![forbid(unsafe_code)]
use core::{fmt, fmt::Debug};

/// Error type for channel send operations without timeout
#[derive(PartialEq, Eq, Clone, Copy)]
pub struct SendError<T>(pub T);

impl<T> Debug for SendError<T> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "SendError(..)")
    }
}

impl<T> fmt::Display for SendError<T> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        fmt::Display::fmt("send to a closed channel", f)
    }
}

impl<T> SendError<T> {
    /// Consumes the error and returns the contained value.
    #[inline]
    pub fn into_inner(self) -> T {
        self.0
    }
}

impl<T> core::error::Error for SendError<T> {}

/// Error type for channel send operations with timeout
#[derive(PartialEq, Eq, Clone, Copy)]
pub enum SendTimeoutError<T> {
    /// Indicates that the channel is closed on both sides with a call to
    /// `close()`
    Closed(T),
    /// Indicates that channel operation reached timeout and is canceled
    Timeout(T),
}

impl<T> Debug for SendTimeoutError<T> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            SendTimeoutError::Closed(..) => write!(f, "Closed(..)"),
            SendTimeoutError::Timeout(..) => write!(f, "Timeout(..)"),
        }
    }
}
impl<T> fmt::Display for SendTimeoutError<T> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        fmt::Display::fmt(
            match *self {
                SendTimeoutError::Closed(..) => "send to a closed channel",
                SendTimeoutError::Timeout(..) => "send timeout",
            },
            f,
        )
    }
}

impl<T> SendTimeoutError<T> {
    /// Consumes the error and returns the contained value.
    #[inline]
    pub fn into_inner(self) -> T {
        match self {
            SendTimeoutError::Closed(value) => value,
            SendTimeoutError::Timeout(value) => value,
        }
    }
}

impl<T> core::error::Error for SendTimeoutError<T> {}

/// Error type for channel receive operations without timeout
#[derive(Debug, PartialEq, Eq)]
pub struct ReceiveError();
impl core::error::Error for ReceiveError {}
impl fmt::Display for ReceiveError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        fmt::Display::fmt("receive from a closed channel", f)
    }
}

/// Error type for channel receive operations with timeout
#[derive(Debug, PartialEq, Eq)]
pub enum ReceiveErrorTimeout {
    /// Indicates that the channel is closed on both sides with a call to
    /// `close()`
    Closed,
    /// Indicates that channel operation reached timeout and is canceled
    Timeout,
}
impl core::error::Error for ReceiveErrorTimeout {}
impl fmt::Display for ReceiveErrorTimeout {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        fmt::Display::fmt(
            match *self {
                ReceiveErrorTimeout::Closed => "receive from a closed channel",
                ReceiveErrorTimeout::Timeout => "receive timeout",
            },
            f,
        )
    }
}

/// Error type for closing a channel when channel is already closed
#[derive(Debug, PartialEq, Eq)]
pub struct CloseError();
impl core::error::Error for CloseError {}
impl fmt::Display for CloseError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        fmt::Display::fmt("channel is already closed", f)
    }
}