sipper 0.1.0

A type-safe future that can notify progress
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

use crate::{Core, Future, Sink};

use pin_project_lite::pin_project;

use std::pin::Pin;
use std::task;

pin_project! {
    /// Runs the [`Sipper`], sending any progress through the given [`Sender`] and returning
    /// its output at the end.
    ///
    /// The result of [`Sipper::run`].
    pub struct Run<S: Core, Si>
    {
        #[pin]
        sipper: S,
        #[pin]
        on_progress: Si,
        state: State<S::Progress>,
    }
}

impl<S: Core, Si> Run<S, Si> {
    pub(crate) fn new(sipper: S, on_progress: Si) -> Self {
        Self {
            sipper,
            on_progress,
            state: State::Read,
        }
    }
}

#[derive(Debug, Clone, Copy)]
enum State<T> {
    Read,
    Send(Option<T>),
    Flush,
    Output,
}

impl<S, Si> Future for Run<S, Si>
where
    S: Core,
    Si: Sink<S::Progress>,
{
    type Output = <S as Core>::Output;

    fn poll(self: Pin<&mut Self>, cx: &mut task::Context<'_>) -> task::Poll<Self::Output> {
        use futures::ready;

        let mut this = self.project();

        loop {
            match this.state {
                State::Read => match ready!(this.sipper.as_mut().poll_next(cx)) {
                    Some(progress) => {
                        *this.state = State::Send(Some(progress));
                    }
                    None => {
                        *this.state = State::Output;
                    }
                },
                State::Send(progress) => match ready!(this.on_progress.as_mut().poll_ready(cx)) {
                    Ok(()) => {
                        let result = this
                            .on_progress
                            .as_mut()
                            .start_send(progress.take().unwrap());

                        if result.is_ok() {
                            *this.state = State::Flush;
                        } else {
                            *this.state = State::Output;
                        }
                    }
                    Err(_) => {
                        *this.state = State::Output;
                    }
                },
                State::Flush => match ready!(this.on_progress.as_mut().poll_flush(cx)) {
                    Ok(_) => {
                        *this.state = State::Read;
                    }
                    Err(_) => {
                        *this.state = State::Output;
                    }
                },
                State::Output => return this.sipper.poll(cx),
            }
        }
    }
}