canary 0.3.3

provides ergonomic abstractions for network communication and more
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

use crate::io::Message;
use crate::{
    err,
    io::Wss,
    serialization::formats::{Format, SendFormat},
    Result,
};
use derive_more::From;
use futures::{stream::SplitSink, SinkExt};
use serde::Serialize;

///
#[derive(From)]
pub enum RefUnformattedRawSendChannel<'a> {
    #[cfg(not(target_arch = "wasm32"))]
    /// tcp backend
    Tcp(&'a mut tokio::net::tcp::OwnedWriteHalf),
    #[cfg(unix)]
    /// unix backend
    Unix(&'a mut tokio::net::unix::OwnedWriteHalf),
    /// wss backend
    WSS(&'a mut SplitSink<Box<Wss>, Message>),
    #[cfg(all(not(target_arch = "wasm32"), feature = "quic"))]
    /// quic backend
    Quic(&'a mut quinn::SendStream),
}

#[derive(From)]
/// Unformatted unnecrypted send channel
pub enum UnformattedRawSendChannel {
    #[cfg(not(target_arch = "wasm32"))]
    /// tcp backend
    Tcp(tokio::net::tcp::OwnedWriteHalf),
    #[cfg(unix)]
    /// unix backend
    Unix(tokio::net::unix::OwnedWriteHalf),
    /// wss backend
    WSS(SplitSink<Box<Wss>, Message>),
    #[cfg(all(not(target_arch = "wasm32"), feature = "quic"))]
    /// quic backend
    Quic(quinn::SendStream),
}

#[derive(From)]
/// Reference unencrypted send channel with format
pub struct RefRawSendChannel<'a, F = Format> {
    /// Inner reference channel
    channel: &'a mut RefUnformattedRawSendChannel<'a>,
    /// Inner format
    format: F,
}

#[derive(From)]
/// Unencrypted send channel with format
pub struct RawSendChannel<F = Format> {
    pub(crate) channel: UnformattedRawSendChannel,
    pub(crate) format: F,
}

impl<'a> From<&'a mut UnformattedRawSendChannel> for RefUnformattedRawSendChannel<'a> {
    #[inline]
    fn from(chan: &'a mut UnformattedRawSendChannel) -> Self {
        match chan {
            #[cfg(not(target_arch = "wasm32"))]
            UnformattedRawSendChannel::Tcp(ref mut chan) => chan.into(),
            #[cfg(unix)]
            UnformattedRawSendChannel::Unix(ref mut chan) => chan.into(),
            UnformattedRawSendChannel::WSS(ref mut chan) => chan.into(),
            #[cfg(all(not(target_arch = "wasm32"), feature = "quic"))]
            UnformattedRawSendChannel::Quic(ref mut chan) => chan.into(),
        }
    }
}

impl<'a> RefUnformattedRawSendChannel<'a> {
    /// Send an object through the channel serialized with format
    /// ```no_run
    /// chan.send("Hello world!", &mut Format::Bincode).await?;
    /// ```
    pub async fn send<T: Serialize, F: SendFormat>(&mut self, obj: T, f: &mut F) -> Result<usize> {
        #[allow(unused)]
        use crate::serialization::tx;
        match self {
            #[cfg(not(target_arch = "wasm32"))]
            RefUnformattedRawSendChannel::Tcp(st) => tx(st, obj, f).await,
            #[cfg(unix)]
            RefUnformattedRawSendChannel::Unix(st) => tx(st, obj, f).await,
            RefUnformattedRawSendChannel::WSS(st) => {
                let buf = f.serialize(&obj).map_err(err!(@invalid_data))?;
                let len = buf.len();

                #[cfg(not(target_arch = "wasm32"))]
                {
                    let item = Message::Binary(buf);
                    st.send(item).await.map_err(err!(@other))?;
                }

                #[cfg(target_arch = "wasm32")]
                {
                    let item = Message::Bytes(buf);
                    st.send(item).await.map_err(|e| err!(e.to_string()))?;
                }

                Ok(len)
            }
            #[cfg(all(not(target_arch = "wasm32"), feature = "quic"))]
            RefUnformattedRawSendChannel::Quic(st) => tx(st, obj, f).await,
        }
    }
    /// Get a formatted channel with the specified format
    /// ```no_run
    /// unformatted.send("Hi!", &mut Format::Bincode).await?;
    /// let mut formatted = unformatted.as_formatted(Format::Bincode).await?;
    /// formatted.send("Hi!").await?;
    /// ```
    pub fn as_formatted<F>(&'a mut self, format: F) -> RefRawSendChannel<'a, F> {
        RefRawSendChannel {
            channel: self,
            format,
        }
    }
}

impl UnformattedRawSendChannel {
    /// Send an object through the channel serialized with format
    /// ```no_run
    /// chan.send("Hello world!", &mut Format::Bincode).await?;
    /// ```
    pub async fn send<T: Serialize, F: SendFormat>(&mut self, obj: T, f: &mut F) -> Result<usize> {
        RefUnformattedRawSendChannel::from(self).send(obj, f).await
    }
    #[inline]
    /// Format the channel
    /// ```no_run
    /// let formatted = unformatted.to_formatted(Format::Bincode);
    /// ```
    pub fn to_formatted<F: SendFormat>(self, format: F) -> RawSendChannel<F> {
        RawSendChannel {
            channel: self,
            format,
        }
    }
}

impl<F: SendFormat> RefRawSendChannel<'_, F> {
    /// Send an object through the channel
    /// ```no_run
    /// chan.send("Hello world!").await?;
    /// ```
    pub async fn send<T: Serialize>(&mut self, obj: T) -> Result<usize> {
        self.channel.send(obj, &mut self.format).await
    }
}

impl<F: SendFormat> RawSendChannel<F> {
    /// Send an object through the channel
    /// ```no_run
    /// chan.send("Hello world!").await?;
    /// ```
    pub async fn send<T: Serialize>(&mut self, obj: T) -> Result<usize> {
        self.channel.send(obj, &mut self.format).await
    }
}