sipper 0.1.0

A type-safe future that can notify progress
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

use crate::Sink;

use futures::channel::mpsc;
use futures::sink;

use std::marker::PhantomData;

/// A sender used to notify the progress of some [`Sipper`].
///
/// [`Sipper`]: crate::Sipper
#[derive(Debug)]
pub struct Sender<T, S = mpsc::Sender<T>> {
    pub(crate) sink: S,
    _output: PhantomData<T>,
}

impl<T> Sender<T> {
    /// Creates a new channel with the given buffer capacity.
    pub fn channel(buffer: usize) -> (Self, mpsc::Receiver<T>) {
        let (sender, receiver) = mpsc::channel(buffer);

        (
            Self {
                sink: sender,
                _output: PhantomData,
            },
            receiver,
        )
    }
}

impl<T> Sender<T, sink::Drain<T>> {
    /// Creates a new [`Sender`] that discards any progress.
    pub fn drain() -> Self {
        Self {
            sink: sink::drain(),
            _output: PhantomData,
        }
    }
}

impl<T, S> Sender<T, S>
where
    S: Sink<T>,
{
    /// Creates a new [`Sender`] from an [`mpsc::Sender`].
    pub fn new(sender: S) -> Self {
        Self {
            sink: sender,
            _output: PhantomData,
        }
    }

    /// Sends a value through the [`Sender`].
    ///
    /// Since we are only notifying progress, any channel errors
    /// are discarded.
    pub async fn send(&mut self, value: T)
    where
        S: Unpin,
    {
        use futures::SinkExt;

        let _ = self.sink.send(value).await;
    }
}

impl<T> From<mpsc::Sender<T>> for Sender<T> {
    fn from(sender: mpsc::Sender<T>) -> Self {
        Sender::new(sender)
    }
}

impl<T> From<&mpsc::Sender<T>> for Sender<T> {
    fn from(sender: &mpsc::Sender<T>) -> Self {
        Sender::new(sender.clone())
    }
}

impl<T, S> From<&Sender<T, S>> for Sender<T, S>
where
    S: Sink<T> + Clone,
{
    fn from(sender: &Sender<T, S>) -> Self {
        Sender::new(sender.clone().sink)
    }
}

impl<T, S> Clone for Sender<T, S>
where
    S: Clone,
{
    fn clone(&self) -> Self {
        Self {
            sink: self.sink.clone(),
            _output: PhantomData,
        }
    }
}