service-io 0.2.0

Build your service-server fast, easy (and without hosting!)
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

//! Channels used to connect inputs with services and services with outputs.
//! It basically wraps a [`tokio::sync::mpsc`] for easy management inside input/output/services
//! implementations.

use crate::message::Message;

use tokio::sync::mpsc;

/// Error indicating that the channel was closed.
#[derive(Debug)]
pub struct ClosedChannel;

/// Sender side of the channel.
/// It basically wraps a [`tokio::sync::mpsc::Sender`] for easy management inside input/output/services
/// implementations.
#[derive(Clone)]
pub struct Sender(pub(crate) mpsc::Sender<Message>);

impl Sender {
    /// Send asynchronously a message.
    ///
    /// This method is a wrapper over [`tokio::sync::mpsc::Sender::send()`] with an specific
    /// mapped error.
    pub async fn send(&self, message: Message) -> Result<(), ClosedChannel> {
        self.0.send(message).await.map_err(|_| ClosedChannel)
    }

    /// Send a message.
    ///
    /// This method is a wrapper over [`tokio::sync::mpsc::Sender::blocking_send()`] with an
    /// specific mapped error.
    pub fn blocking_send(&self, message: Message) -> Result<(), ClosedChannel> {
        self.0.blocking_send(message).map_err(|_| ClosedChannel)
    }
}

/// Receiver side of the channel.
/// It basically wraps a [`tokio::sync::mpsc::Receiver`] for easy management inside input/output/services
/// implementations.
pub struct Receiver(pub(crate) mpsc::Receiver<Message>);

impl Receiver {
    /// Receive asynchronously a message.
    ///
    /// This method is a wrapper over [`tokio::sync::mpsc::Receiver::recv()`] with an specific
    /// mapped error.
    pub async fn recv(&mut self) -> Result<Message, ClosedChannel> {
        self.0.recv().await.ok_or(ClosedChannel)
    }
}