camber 0.4.2

Opinionated async Rust for IO-bound services on top of Tokio
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

use crate::RuntimeError;
use std::fmt;
use tokio::sync::mpsc as tokio_mpsc;

/// Create a bounded MPSC channel with the given capacity.
///
/// `MpscSender` uses blocking send (safe from sync camber tasks).
/// `MpscReceiver` uses async recv (designed for `spawn_async` / `every_async`).
pub fn mpsc<T>(cap: usize) -> Result<(MpscSender<T>, MpscReceiver<T>), RuntimeError> {
    match cap {
        0 => Err(RuntimeError::InvalidArgument(
            "mpsc channel capacity must be greater than zero".into(),
        )),
        _ => {
            let (tx, rx) = tokio_mpsc::channel(cap);
            Ok((MpscSender { inner: tx }, MpscReceiver { inner: rx }))
        }
    }
}

/// Sending half of an async MPSC channel.
pub struct MpscSender<T> {
    inner: tokio_mpsc::Sender<T>,
}

impl<T> MpscSender<T> {
    /// Blocking send. Safe from sync contexts and multi-thread Tokio runtimes.
    ///
    /// A current-thread runtime cannot make progress while this call blocks,
    /// so that context is refused with `BlockingInAsyncContext` instead of
    /// allowing Tokio's `blocking_send` panic to escape a `Result` API.
    pub fn send(&self, value: T) -> Result<(), RuntimeError> {
        match tokio::runtime::Handle::try_current() {
            Ok(handle) => self.send_from_runtime(handle.runtime_flavor(), value),
            Err(_) => self.blocking_send(value),
        }
    }

    fn send_from_runtime(
        &self,
        flavor: tokio::runtime::RuntimeFlavor,
        value: T,
    ) -> Result<(), RuntimeError> {
        match flavor {
            tokio::runtime::RuntimeFlavor::MultiThread => {
                tokio::task::block_in_place(|| self.blocking_send(value))
            }
            tokio::runtime::RuntimeFlavor::CurrentThread => {
                Err(RuntimeError::BlockingInAsyncContext)
            }
            _ => Err(RuntimeError::BlockingInAsyncContext),
        }
    }

    fn blocking_send(&self, value: T) -> Result<(), RuntimeError> {
        self.inner
            .blocking_send(value)
            .map_err(|_| RuntimeError::ChannelClosed)
    }

    /// Non-blocking send. Returns `Err(ChannelFull)` if the buffer is full.
    pub fn try_send(&self, value: T) -> Result<(), RuntimeError> {
        self.inner.try_send(value).map_err(|e| match e {
            tokio_mpsc::error::TrySendError::Full(_) => RuntimeError::ChannelFull,
            tokio_mpsc::error::TrySendError::Closed(_) => RuntimeError::ChannelClosed,
        })
    }
}

impl<T> Clone for MpscSender<T> {
    fn clone(&self) -> Self {
        Self {
            inner: self.inner.clone(),
        }
    }
}

impl<T> fmt::Debug for MpscSender<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("MpscSender").finish()
    }
}

/// Receiving half of an async MPSC channel.
pub struct MpscReceiver<T> {
    inner: tokio_mpsc::Receiver<T>,
}

impl<T> MpscReceiver<T> {
    /// Async receive. Returns `None` when all senders are dropped.
    pub async fn recv(&mut self) -> Option<T> {
        self.inner.recv().await
    }

    /// Close the receiver. Remaining buffered messages can still be received.
    pub fn close(&mut self) {
        self.inner.close();
    }
}

impl<T> fmt::Debug for MpscReceiver<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("MpscReceiver").finish()
    }
}