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

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

use core::fmt::Debug;

use std::collections::BinaryHeap;

use crate::prelude::*;

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

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

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

impl<T: Ord> 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(item);
                Ok(())
            }

            Right(()) => Ok(()),
        }
    }

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

impl<T: Ord> crate::IntoConsumer for BinaryHeap<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 BinaryHeap<T>`; it adds consumed data to the [`BinaryHeap`].
///
/// ```
/// use ufotofu::prelude::*;
/// use std::collections::BinaryHeap;
/// # pollster::block_on(async{
/// let mut heap = BinaryHeap::new();
/// let mut c = (&mut heap).into_consumer();
///
/// c.consume_item(1).await?;
/// c.consume_item(4).await?;
/// c.consume_item(2).await?;
///
/// assert_eq!(heap.pop(), Some(4));
/// assert_eq!(heap.pop(), Some(2));
/// assert_eq!(heap.pop(), Some(1));
/// assert_eq!(heap.pop(), None);
/// # Result::<(), Infallible>::Ok(())
/// # });
/// ```
///
/// <br/>Counterpart: the [producer::compat::binary_heap::IntoProducerRef] type.
#[derive(Debug)]

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

impl<'a, T: Ord> 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(item);
                Ok(())
            }

            Right(()) => Ok(()),
        }
    }

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

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

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