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

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

use crate::raw::*;
use crate::*;
use bytes::Bytes;
use futures::SinkExt;
use std::pin::Pin;
use std::task::{Context, Poll};

/// FuturesBytesSink is the adapter of [`Sink`] generated by [`Writer::into_bytes_sink`].
///
/// Users can use this adapter in cases where they need to use [`Sink`] trait. FuturesBytesSink
/// reuses the same concurrent and chunk settings from [`Writer`].
///
/// FuturesBytesSink also implements [`Unpin`], [`Send`] and [`Sync`].
pub struct FuturesBytesSink {
    sink: BufferSink,
}

impl FuturesBytesSink {
    /// Create a new sink from a [`oio::Writer`].
    #[inline]
    pub(crate) fn new(w: oio::Writer) -> Self {
        FuturesBytesSink {
            sink: BufferSink::new(w),
        }
    }
}

impl futures::Sink<Bytes> for FuturesBytesSink {
    type Error = std::io::Error;

    fn poll_ready(
        mut self: Pin<&mut Self>,
        cx: &mut Context<'_>,
    ) -> Poll<Result<(), std::io::Error>> {
        self.sink.poll_ready_unpin(cx).map_err(format_std_io_error)
    }

    fn start_send(mut self: Pin<&mut Self>, item: Bytes) -> Result<(), std::io::Error> {
        self.sink
            .start_send_unpin(Buffer::from(item))
            .map_err(format_std_io_error)
    }

    fn poll_flush(
        mut self: Pin<&mut Self>,
        cx: &mut Context<'_>,
    ) -> Poll<Result<(), std::io::Error>> {
        self.sink.poll_flush_unpin(cx).map_err(format_std_io_error)
    }

    fn poll_close(
        mut self: Pin<&mut Self>,
        cx: &mut Context<'_>,
    ) -> Poll<Result<(), std::io::Error>> {
        self.sink.poll_close_unpin(cx).map_err(format_std_io_error)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::raw::MaybeSend;

    #[test]
    fn test_trait() {
        let v = FuturesBytesSink::new(Box::new(()));

        let _: Box<dyn Unpin + MaybeSend + Sync + 'static> = Box::new(v);
    }
}