collab-common 0.0.7

Code shared by collab's client and server
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

use core::pin::Pin;
use core::task::Context;

use futures::task::Poll;
use futures::{Sink, Stream};
use pin_project_lite::pin_project;

pin_project! {
    /// A [`Stream`] adapter that executes a callback with the buffer returned
    /// by the underlying stream.
    pub struct CallbackStream<S, T: ?Sized> {
        #[pin]
        inner: S,
        callback: fn(&T),
    }
}

impl<S, T: ?Sized> CallbackStream<S, T> {
    /// TODO: docs
    #[inline]
    pub fn inner_mut(&mut self) -> &mut S {
        &mut self.inner
    }

    /// Creates a new [`CallbackStream`] wrapping the given stream.
    #[inline]
    pub fn new(stream: S, callback: fn(&T)) -> Self {
        Self { inner: stream, callback }
    }
}

impl<S, T, U, E> Stream for CallbackStream<S, T>
where
    // We have force the `Item` of the underlying stream to be a `Result<T, E>`
    // because this struct usually wraps such streams.
    //
    // Ideally we'd like to have a separate impl for `Stream<Item = U>` where
    // `U: AsRef<T>`, but that's not possible without specialization.
    S: Stream<Item = Result<U, E>>,
    U: AsRef<T>,
    T: ?Sized,
{
    type Item = S::Item;

    #[inline]
    fn poll_next(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
    ) -> Poll<Option<Self::Item>> {
        let this = self.project();

        let out = this.inner.poll_next(cx);

        if let Poll::Ready(Some(Ok(item))) = &out {
            (this.callback)(item.as_ref());
        }

        out
    }
}

pin_project! {
    /// A [`Sink`] adapter that executes a callback with the buffer given to
    /// `start_send` before forwarding it to the underlying sink.
    pub struct CallbackSink<S, T:?Sized> {
        #[pin]
        inner: S,
        callback: fn(&T),
    }
}

impl<S, T: ?Sized> CallbackSink<S, T> {
    /// TODO: docs
    #[inline]
    pub fn inner_mut(&mut self) -> &mut S {
        &mut self.inner
    }

    /// Creates a new [`CallbackSink`] wrapping the given sink.
    #[inline]
    pub fn new(sink: S, callback: fn(&T)) -> Self {
        Self { inner: sink, callback }
    }
}

impl<S, T, U> Sink<U> for CallbackSink<S, T>
where
    S: Sink<U>,
    U: AsRef<T>,
    T: ?Sized,
{
    type Error = S::Error;

    #[inline]
    fn poll_ready(
        self: Pin<&mut Self>,
        ctx: &mut Context<'_>,
    ) -> Poll<Result<(), Self::Error>> {
        self.project().inner.poll_ready(ctx)
    }

    #[inline]
    fn start_send(self: Pin<&mut Self>, item: U) -> Result<(), Self::Error> {
        let this = self.project();
        (this.callback)(item.as_ref());
        this.inner.start_send(item)
    }

    #[inline]
    fn poll_flush(
        self: Pin<&mut Self>,
        ctx: &mut Context<'_>,
    ) -> Poll<Result<(), Self::Error>> {
        self.project().inner.poll_flush(ctx)
    }

    #[inline]
    fn poll_close(
        self: Pin<&mut Self>,
        ctx: &mut Context<'_>,
    ) -> Poll<Result<(), Self::Error>> {
        self.project().inner.poll_close(ctx)
    }
}