ufotofu 0.12.5

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

//! Consumer functionality for [`VecDeque`].
//!
//! Specifically, the module provides
//!
//! - an [`IntoConsumer`] impl for `VecDeque<T>`,
//! - an [`IntoConsumer`] impl for `&mut VecDeque<T>`.
//!
//! <br/>Counterpart: the [`producer::compat::vec_deque`] module.

use core::fmt::Debug;

use std::collections::VecDeque;

use crate::prelude::*;

/// The consumer of the [`IntoConsumer`] impl of `VecDeque<T>`; it adds consumed data at the back of the [`VecDeque`].
///
/// Use the [`Into`] impl to recover the deque when you are done consuming items.
///
/// ```
/// use ufotofu::prelude::*;
/// use std::collections::VecDeque;
/// # pollster::block_on(async{
/// let mut c = VecDeque::new().into_consumer();
///
/// c.consume_item(1).await?;
/// c.consume_item(2).await?;
/// c.consume_item(4).await?;
///
/// let mut deque: VecDeque<_> = c.into();
/// let collected: Vec<_> = deque.into_iter().collect();
/// assert_eq!(collected, vec![1, 2, 4]);
/// # Result::<(), Infallible>::Ok(())
/// # });
/// ```
///
/// <br/>Counterpart: the [producer::compat::vec_deque::IntoProducer] type.
#[derive(Debug)]

pub struct IntoConsumer<T>(VecDeque<T>);

impl<T> From<IntoConsumer<T>> for VecDeque<T> {
    fn from(value: IntoConsumer<T>) -> Self {
        value.0
    }
}

impl<T> Consumer for IntoConsumer<T> {
    type Item = T;
    type Final = ();
    type Error = Infallible;

    async fn consume(&mut self, val: Either<Self::Item, Self::Final>) -> Result<(), Self::Error> {
        match val {
            Left(item) => {
                self.0.push_back(item);
                Ok(())
            }
            Right(()) => Ok(()),
        }
    }

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

impl<T> crate::IntoConsumer for VecDeque<T> {
    type Item = T;
    type Final = ();
    type Error = Infallible;
    type IntoConsumer = IntoConsumer<T>;

    fn into_consumer(self) -> Self::IntoConsumer {
        IntoConsumer(self)
    }
}

/// The consumer of the [`IntoConsumer`] impl of `&mut VecDeque<T>`; it adds consumed data at the back of the [`VecDeque`].
///
/// ```
/// use ufotofu::prelude::*;
/// use std::collections::VecDeque;
/// # pollster::block_on(async{
/// let mut deque = VecDeque::new();
/// let mut c = (&mut deque).into_consumer();
///
/// c.consume_item(1).await?;
/// c.consume_item(2).await?;
/// c.consume_item(4).await?;
///
/// let collected: Vec<_> = deque.into_iter().collect();
/// assert_eq!(collected, vec![1, 2, 4]);
/// # Result::<(), Infallible>::Ok(())
/// # });
/// ```
///
/// <br/>Counterpart: the [producer::compat::vec_deque::IntoProducerRef] type.
#[derive(Debug)]

pub struct IntoConsumerMut<'a, T>(&'a mut VecDeque<T>);

impl<'a, T> Consumer for IntoConsumerMut<'a, T> {
    type Item = T;
    type Final = ();
    type Error = Infallible;

    async fn consume(&mut self, val: Either<Self::Item, Self::Final>) -> Result<(), Self::Error> {
        match val {
            Left(item) => {
                self.0.push_back(item);
                Ok(())
            }
            Right(()) => Ok(()),
        }
    }

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

impl<'a, T> crate::IntoConsumer for &'a mut VecDeque<T> {
    type Item = T;
    type Final = ();
    type Error = Infallible;
    type IntoConsumer = IntoConsumerMut<'a, T>;

    fn into_consumer(self) -> Self::IntoConsumer {
        IntoConsumerMut(self)
    }
}