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
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

//! Producer functionality for [`BTreeMap`].
//!
//! Specifically, the module provides
//!
//! - an [`IntoProducer`] impl for `BTreeMap<K, V>`,
//! - an [`IntoProducer`] impl for `&BTreeMap<K, V>`, and
//! - an [`IntoProducer`] impl for `&mut BTreeMap<K, V>`.
//!
//! <br/>Counterpart: the [`consumer::compat::btree_map`] module.

use std::collections::BTreeMap;

use crate::{
    prelude::*,
    producer::compat::{iterator_to_producer, IteratorToProducer},
};

/// The producer of the [`IntoProducer`] impl of `BTreeMap<K, V>`.
///
/// ```
/// use std::collections::BTreeMap;
/// use ufotofu::prelude::*;
/// # pollster::block_on(async{
/// let map: BTreeMap<_, _> = vec![(1, 'a'), (2, 'b'), (4, 'd')].into_iter().collect();
/// let mut p = map.into_producer();
///
/// assert_eq!(p.produce().await?, Left((1, 'a')));
/// assert_eq!(p.produce().await?, Left((2, 'b')));
/// assert_eq!(p.produce().await?, Left((4, 'd')));
/// assert_eq!(p.produce().await?, Right(()));
/// # Result::<(), Infallible>::Ok(())
/// # });
/// ```
///
/// <br/>Counterpart: [`consumer::compat::btree_map::IntoConsumer`].
pub struct IntoProducer<K, V>(IteratorToProducer<<BTreeMap<K, V> as IntoIterator>::IntoIter>);

impl<K, V> Producer for IntoProducer<K, V> {
    type Item = (K, V);
    type Final = ();
    type Error = Infallible;

    async fn produce(&mut self) -> Result<Either<Self::Item, Self::Final>, Self::Error> {
        self.0.produce().await
    }

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

impl<K, V> crate::IntoProducer for BTreeMap<K, V> {
    type Item = (K, V);
    type Final = ();
    type Error = Infallible;
    type IntoProducer = IntoProducer<K, V>;

    fn into_producer(self) -> Self::IntoProducer {
        IntoProducer(iterator_to_producer(
            <BTreeMap<K, V> as IntoIterator>::into_iter(self),
        ))
    }
}

/// The producer of the [`IntoProducer`] impl of `&BTreeMap<K, V>`.
///
/// ```
/// use std::collections::BTreeMap;
/// use ufotofu::prelude::*;
/// # pollster::block_on(async{
/// let map: BTreeMap<_, _> = vec![(1, 'a'), (2, 'b'), (4, 'd')].into_iter().collect();
/// let mut p = (&map).into_producer();
///
/// assert_eq!(p.produce().await?, Left((&1, &'a')));
/// assert_eq!(p.produce().await?, Left((&2, &'b')));
/// assert_eq!(p.produce().await?, Left((&4, &'d')));
/// assert_eq!(p.produce().await?, Right(()));
/// # Result::<(), Infallible>::Ok(())
/// # });
/// ```
///
/// <br/>Counterpart: [`consumer::compat::btree_map::IntoConsumerMut`].
pub struct IntoProducerRef<'s, K, V>(
    IteratorToProducer<<&'s BTreeMap<K, V> as IntoIterator>::IntoIter>,
);

impl<'s, K, V> Producer for IntoProducerRef<'s, K, V> {
    type Item = (&'s K, &'s V);
    type Final = ();
    type Error = Infallible;

    async fn produce(&mut self) -> Result<Either<Self::Item, Self::Final>, Self::Error> {
        self.0.produce().await
    }

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

impl<'s, K, V> crate::IntoProducer for &'s BTreeMap<K, V> {
    type Item = (&'s K, &'s V);
    type Final = ();
    type Error = Infallible;
    type IntoProducer = IntoProducerRef<'s, K, V>;

    fn into_producer(self) -> Self::IntoProducer {
        IntoProducerRef(iterator_to_producer(self.iter()))
    }
}

/// The producer of the [`IntoProducer`] impl of `&mut BTreeMap<K, V>`.
///
/// ```
/// use std::collections::BTreeMap;
/// use ufotofu::prelude::*;
/// # pollster::block_on(async{
/// let mut map: BTreeMap<_, _> = vec![(1, 'a'), (2, 'b'), (4, 'd')].into_iter().collect();
/// let mut p = (&mut map).into_producer();
///
/// assert_eq!(p.produce().await?, Left((&1, &mut 'a')));
/// let (k, mut v) = p.produce().await?.unwrap_left();
/// *v = 'q';
/// assert_eq!(p.produce().await?, Left((&4, &mut 'd')));
/// assert_eq!(p.produce().await?, Right(()));
/// assert_eq!(map, vec![(1, 'a'), (2, 'q'), (4, 'd')].into_iter().collect::<BTreeMap<_, _>>());
/// # Result::<(), Infallible>::Ok(())
/// # });
/// ```
///
/// <br/>Counterpart: none, because you cannot consume into a collection behind an immutable reference.
pub struct IntoProducerMut<'s, K, V>(
    IteratorToProducer<<&'s mut BTreeMap<K, V> as IntoIterator>::IntoIter>,
);

impl<'s, K, V> Producer for IntoProducerMut<'s, K, V> {
    type Item = (&'s K, &'s mut V);
    type Final = ();
    type Error = Infallible;

    async fn produce(&mut self) -> Result<Either<Self::Item, Self::Final>, Self::Error> {
        self.0.produce().await
    }

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

impl<'s, K, V> crate::IntoProducer for &'s mut BTreeMap<K, V> {
    type Item = (&'s K, &'s mut V);
    type Final = ();
    type Error = Infallible;
    type IntoProducer = IntoProducerMut<'s, K, V>;

    fn into_producer(self) -> Self::IntoProducer {
        IntoProducerMut(iterator_to_producer(self.iter_mut()))
    }
}