multipart-write 0.1.0

Sink-like interface for writing an object in parts
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

use std::fmt::{self, Debug, Formatter};
use std::marker::PhantomData;
use std::pin::Pin;
use std::task::{Context, Poll};

use futures_core::ready;

use crate::{FusedMultipartWrite, MultipartWrite};

pin_project_lite::pin_project! {
    /// `MultipartWrite` for [`fold_sent`].
    ///
    ///[`fold_sent`]: super::MultipartWriteExt::fold_sent
    #[must_use = "futures do nothing unless polled"]
    pub struct FoldSent<Wr, T, F, Part> {
        #[pin]
        writer: Wr,
        acc: Option<T>,
        f: F,
        _p: PhantomData<Part>,
    }
}

impl<Wr, T, F, Part> FoldSent<Wr, T, F, Part> {
    pub(super) fn new(writer: Wr, id: T, f: F) -> Self {
        Self { writer, acc: Some(id), f, _p: PhantomData }
    }

    /// Consumes `FoldSent`, returning the underlying writer.
    pub fn into_inner(self) -> Wr {
        self.writer
    }

    /// Acquires a reference to the underlying writer.
    pub fn get_ref(&self) -> &Wr {
        &self.writer
    }

    /// Acquires a mutable reference to the underlying writer.
    ///
    /// It is inadvisable to directly write to the underlying writer.
    pub fn get_mut(&mut self) -> &mut Wr {
        &mut self.writer
    }

    /// Acquires a pinned mutable reference to the underlying writer.
    ///
    /// It is inadvisable to directly write to the underlying writer.
    pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut Wr> {
        self.project().writer
    }
}

impl<Wr, T, F, Part> FusedMultipartWrite<Part> for FoldSent<Wr, T, F, Part>
where
    Wr: FusedMultipartWrite<Part>,
    F: FnMut(T, &Wr::Recv) -> T,
{
    fn is_terminated(&self) -> bool {
        self.writer.is_terminated()
    }
}

impl<Wr, T, F, Part> MultipartWrite<Part> for FoldSent<Wr, T, F, Part>
where
    Wr: MultipartWrite<Part>,
    F: FnMut(T, &Wr::Recv) -> T,
{
    type Error = Wr::Error;
    type Output = (T, Wr::Output);
    type Recv = Wr::Recv;

    fn poll_ready(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
    ) -> Poll<Result<(), Self::Error>> {
        self.project().writer.poll_ready(cx)
    }

    fn start_send(
        self: Pin<&mut Self>,
        part: Part,
    ) -> Result<Self::Recv, Self::Error> {
        let mut this = self.project();
        let ret = this.writer.as_mut().start_send(part)?;
        let new_acc = this.acc.take().map(|acc| (this.f)(acc, &ret));
        *this.acc = new_acc;
        Ok(ret)
    }

    fn poll_flush(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
    ) -> Poll<Result<(), Self::Error>> {
        self.project().writer.poll_flush(cx)
    }

    fn poll_complete(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
    ) -> Poll<Result<Self::Output, Self::Error>> {
        let mut this = self.project();
        let out = ready!(this.writer.as_mut().poll_complete(cx))?;
        let acc = this.acc.take().expect("polled FoldSent after completion");
        Poll::Ready(Ok((acc, out)))
    }
}

impl<Wr, T, F, Part> Debug for FoldSent<Wr, T, F, Part>
where
    Wr: Debug,
    T: Debug,
{
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        f.debug_struct("FoldSent")
            .field("writer", &self.writer)
            .field("acc", &self.acc)
            .finish()
    }
}