ufotofu 0.12.2

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

use crate::{prelude::*, ConsumeLimitError};

/// A `Consumer` adaptor that limits the number of regular items accepted by the Consumer.
///
/// Use the [`into_inner`](`Limit::into_inner`) method or [`AsRef<C>`](AsRef) impl to access the wrapped consumer.
///
/// Created via the [`ConsumerExt::to_limit`] method.
///
/// <br/>Counterpart: the [`producer::Limit`] type.
#[derive(Copy, Clone, Hash, Ord, Eq, PartialEq, PartialOrd, Debug)]
pub struct Limit<C> {
    inner: C,
    remaining: usize,
}

impl<C> Limit<C> {
    pub(crate) fn new(inner: C, limit: usize) -> Self {
        Limit {
            inner,
            remaining: limit,
        }
    }

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

    /// Returns the number of items that can still be consumed before returning an error.
    pub fn remaining(&self) -> usize {
        self.remaining
    }
}

impl<C> AsRef<C> for Limit<C> {
    fn as_ref(&self) -> &C {
        &self.inner
    }
}

impl<C: Consumer> Consumer for Limit<C> {
    type Item = C::Item;
    type Final = C::Final;
    type Error = ConsumeLimitError<C::Error>;

    async fn consume(&mut self, val: Either<Self::Item, Self::Final>) -> Result<(), Self::Error> {
        match val {
            Left(item) => match self.remaining.checked_sub(1) {
                None => Result::Err(ConsumeLimitError::LimitReached),
                Some(decremented) => {
                    self.remaining = decremented;
                    self.inner
                        .consume_item(item)
                        .await
                        .map_err(|err| ConsumeLimitError::Inner(err))
                }
            },
            Right(fin) => self
                .inner
                .consume_final(fin)
                .await
                .map_err(|err| ConsumeLimitError::Inner(err)),
        }
    }

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

impl<C: BulkConsumer> BulkConsumer for Limit<C> {
    async fn expose_slots_gracefully<F, R>(&mut self, f: F) -> Result<R, (F, Self::Error)>
    where
        F: AsyncFnOnce(&mut [Self::Item]) -> (usize, R),
    {
        if self.remaining == 0 {
            return Err((f, ConsumeLimitError::LimitReached));
        }

        let mut f = Some(f);
        let mut remaining = self.remaining;

        let ret = self
            .inner
            .expose_slots(async |slots| {
                let len = remaining.min(slots.len());
                remaining = remaining - len;
                let inner_f = f.take().expect("This only runs once, so f is safe to take");
                inner_f(&mut slots[..len]).await
            })
            .await;
        self.remaining = remaining;

        match ret {
            Ok(r) => Ok(r),
            Err(error) => Err((
                f.take()
                    .expect("Wrapper closure wasn't called, so f is safe to take"),
                ConsumeLimitError::Inner(error),
            )),
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::prelude::*;
    use crate::ConsumeLimitError;

    #[test]
    fn inner_error() {
        let mut c = consumer::error_immediately("internal_error").to_limit(20);
        pollster::block_on(async {
            assert_eq!(
                c.flush().await,
                Err(ConsumeLimitError::Inner("internal_error"))
            );
        });
    }
}