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

//! Consumer functionality for [`HashMap`].
//!
//! Specifically, the module provides
//!
//! - an [`IntoConsumer`] impl for `HashMap<K, V>`,
//! - an [`IntoConsumer`] impl for `&mut HashMap<K, V>`.
//!
//! <br/>Counterpart: the [`producer::compat::btree_map`] module.

use core::fmt::Debug;
use core::hash::Hash;

use std::collections::HashMap;

use crate::prelude::*;

/// The consumer of the [`IntoConsumer`] impl of `HashMap<K, V>`; it inserts key-value pairs to the [`HashMap`].
///
/// Use the [`Into`] impl to recover the map when you are done consuming items.
///
/// ```
/// use ufotofu::prelude::*;
/// use std::collections::HashMap;
/// # pollster::block_on(async{
/// let mut c = HashMap::new().into_consumer();
///
/// c.consume_item((1, 'a')).await?;
/// c.consume_item((4, 'q')).await?;
/// c.consume_item((2, 'b')).await?;
/// c.consume_item((4, 'd')).await?;
///
/// let mut map: HashMap<_, _> = c.into();
/// assert_eq!(map, vec![(1, 'a'), (2, 'b'), (4, 'd')].into_iter().collect::<HashMap<_, _>>());
/// # Result::<(), Infallible>::Ok(())
/// # });
/// ```
///
/// <br/>Counterpart: the [producer::compat::hash_map::IntoProducer] type.
#[derive(Debug)]

pub struct IntoConsumer<K, V>(HashMap<K, V>);

impl<K, V> From<IntoConsumer<K, V>> for HashMap<K, V> {
    fn from(value: IntoConsumer<K, V>) -> Self {
        value.0
    }
}

impl<K: Hash + Eq, V> Consumer for IntoConsumer<K, V> {
    type Item = (K, V);
    type Final = ();
    type Error = Infallible;

    /// Inserts the key-value pair into the map.
    async fn consume(&mut self, val: Either<Self::Item, Self::Final>) -> Result<(), Self::Error> {
        match val {
            Left(item) => {
                self.0.insert(item.0, item.1);
                Ok(())
            }
            Right(()) => Ok(()),
        }
    }

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

impl<K: Hash + Eq, V> crate::IntoConsumer for HashMap<K, V> {
    type Item = (K, V);
    type Final = ();
    type Error = Infallible;
    type IntoConsumer = IntoConsumer<K, V>;

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

/// The consumer of the [`IntoConsumer`] impl of `&mut HashMap<K, V>`; it inserts consumed key-value pairs into the [`HashMap`].
///
/// ```
/// use ufotofu::prelude::*;
/// use std::collections::HashMap;
/// # pollster::block_on(async{
/// let mut map = HashMap::new();
/// let mut c = (&mut map).into_consumer();
///
/// c.consume_item((1, 'a')).await?;
/// c.consume_item((4, 'q')).await?;
/// c.consume_item((2, 'b')).await?;
/// c.consume_item((4, 'd')).await?;
///
/// assert_eq!(map, vec![(1, 'a'), (2, 'b'), (4, 'd')].into_iter().collect::<HashMap<_, _>>());
/// # Result::<(), Infallible>::Ok(())
/// # });
/// ```
///
/// <br/>Counterpart: the [producer::compat::hash_map::IntoProducerRef] type.
#[derive(Debug)]

pub struct IntoConsumerMut<'a, K, V>(&'a mut HashMap<K, V>);

impl<'a, K: Hash + Eq, V> Consumer for IntoConsumerMut<'a, K, V> {
    type Item = (K, V);
    type Final = ();
    type Error = Infallible;

    /// Inserts the key-value pair into the map.
    async fn consume(&mut self, val: Either<Self::Item, Self::Final>) -> Result<(), Self::Error> {
        match val {
            Left(item) => {
                self.0.insert(item.0, item.1);
                Ok(())
            }
            Right(()) => Ok(()),
        }
    }

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

impl<'a, K: Hash + Eq, V> crate::IntoConsumer for &'a mut HashMap<K, V> {
    type Item = (K, V);
    type Final = ();
    type Error = Infallible;
    type IntoConsumer = IntoConsumerMut<'a, K, V>;

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