ufotofu 0.12.0

Abstractions for lazily consuming and producing sequences
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199

use core::fmt;
use core::marker::PhantomData;

use crate::prelude::*;

/// A (bulk) consumer wrapper which passes final values through a function before forwarding them to the wrapped consumer.
///
/// Use the `AsRef<C>` and `AsMut<C>` impls to access the wrapped consumer.
///
/// Created via [`ConsumerExt::to_map_final`].
///
/// <br/>Counterpart: the [producer::MapFinal] type.
pub struct MapFinal<C, Fun, NewFinal> {
    inner: C,
    fun: Option<Fun>,
    phantom: PhantomData<NewFinal>,
}

impl<C, Fun, NewFinal> fmt::Debug for MapFinal<C, Fun, NewFinal>
where
    C: fmt::Debug,
    Fun: fmt::Debug,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("MapFinal")
            .field("inner", &self.inner)
            .field("fun", &self.fun)
            .finish()
    }
}

impl<C, Fun, NewFinal> MapFinal<C, Fun, NewFinal> {
    pub(crate) fn new(inner: C, fun: Fun) -> Self {
        Self {
            inner,
            fun: Some(fun),
            phantom: PhantomData,
        }
    }

    /// Consumes `self` and returns the wrapped consumer.
    pub fn into_inner(self) -> C {
        self.inner
    }
}

impl<C, Fun, NewFinal> AsRef<C> for MapFinal<C, Fun, NewFinal> {
    fn as_ref(&self) -> &C {
        &self.inner
    }
}

impl<C, Fun, NewFinal> AsMut<C> for MapFinal<C, Fun, NewFinal> {
    fn as_mut(&mut self) -> &mut C {
        &mut self.inner
    }
}

impl<C, Fun, NewFinal> Consumer for MapFinal<C, Fun, NewFinal>
where
    C: Consumer,
    Fun: FnOnce(NewFinal) -> C::Final,
{
    type Item = C::Item;
    type Final = NewFinal;
    type Error = C::Error;

    async fn consume(&mut self, val: Either<Self::Item, Self::Final>) -> Result<(), Self::Error> {
        match val {
            Left(item) => self.inner.consume_item(item).await,
            Right(fin) => {
                self.inner
                    .consume_final((self
                        .fun
                        .take()
                        .expect("Must not use a consumer after writing a final value to it"))(
                        fin,
                    ))
                    .await
            }
        }
    }

    async fn flush(&mut self) -> Result<(), Self::Error> {
        self.inner.flush().await
    }
}

impl<C, Fun, NewFinal> BulkConsumer for MapFinal<C, Fun, NewFinal>
where
    C: BulkConsumer,
    Fun: FnOnce(NewFinal) -> C::Final,
{
    async fn expose_slots_gracefully<F, R>(&mut self, f: F) -> Result<R, (F, Self::Error)>
    where
        F: AsyncFnOnce(&mut [Self::Item]) -> (usize, R),
    {
        self.inner.expose_slots_gracefully(f).await
    }
}

/// A (bulk) consumer wrapper which passes final values through an async function before forwarding them to the wrapped consumer.
///
/// Use the `AsRef<C>` and `AsMut<C>` impls to access the wrapped consumer.
///
/// Created via [`ConsumerExt::to_map_async_final`].
///
/// <br/>Counterpart: the [producer::MapAsyncFinal] type.
pub struct MapAsyncFinal<C, Fun, NewFinal> {
    inner: C,
    fun: Option<Fun>,
    phantom: PhantomData<NewFinal>,
}

impl<C, Fun, NewFinal> fmt::Debug for MapAsyncFinal<C, Fun, NewFinal>
where
    C: fmt::Debug,
    Fun: fmt::Debug,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("MapAsyncFinal")
            .field("inner", &self.inner)
            .field("fun", &self.fun)
            .finish()
    }
}

impl<C, Fun, NewFinal> MapAsyncFinal<C, Fun, NewFinal> {
    pub(crate) fn new(inner: C, fun: Fun) -> Self {
        Self {
            inner,
            fun: Some(fun),
            phantom: PhantomData,
        }
    }

    /// Consumes `self` and returns the wrapped consumer.
    pub fn into_inner(self) -> C {
        self.inner
    }
}

impl<C, Fun, NewFinal> AsRef<C> for MapAsyncFinal<C, Fun, NewFinal> {
    fn as_ref(&self) -> &C {
        &self.inner
    }
}

impl<C, Fun, NewFinal> AsMut<C> for MapAsyncFinal<C, Fun, NewFinal> {
    fn as_mut(&mut self) -> &mut C {
        &mut self.inner
    }
}

impl<C, Fun, NewFinal> Consumer for MapAsyncFinal<C, Fun, NewFinal>
where
    C: Consumer,
    Fun: AsyncFnOnce(NewFinal) -> C::Final,
{
    type Item = C::Item;
    type Final = NewFinal;
    type Error = C::Error;

    async fn consume(&mut self, val: Either<Self::Item, Self::Final>) -> Result<(), Self::Error> {
        match val {
            Left(item) => self.inner.consume_item(item).await,
            Right(fin) => {
                self.inner
                    .consume_final(
                        (self
                            .fun
                            .take()
                            .expect("Must not use a consumer after writing a final value to it"))(
                            fin,
                        )
                        .await,
                    )
                    .await
            }
        }
    }

    async fn flush(&mut self) -> Result<(), Self::Error> {
        self.inner.flush().await
    }
}

impl<C, Fun, NewFinal> BulkConsumer for MapAsyncFinal<C, Fun, NewFinal>
where
    C: BulkConsumer,
    Fun: AsyncFnOnce(NewFinal) -> C::Final,
{
    async fn expose_slots_gracefully<F, R>(&mut self, f: F) -> Result<R, (F, Self::Error)>
    where
        F: AsyncFnOnce(&mut [Self::Item]) -> (usize, R),
    {
        self.inner.expose_slots_gracefully(f).await
    }
}