Struct body_image_futio::UniBodySink

pub struct UniBodySink { /* private fields */ }

Adaptor for BodySink implementing the futures::Sink trait. This allows a Stream<Item=UniBodyBuf> to be forwarded (e.g. via futures::Stream::forward) to a BodySink, in a fully asynchronous fashion and with zero-copy MemMap support (mmap feature only).

Tunables are used during the streaming to decide when to write back a BodySink in Ram to FsWrite. This implementation uses tokio_threadpool::blocking to request becoming a backup thread for blocking operations including BodySink::write_back and BodySink::write_all (state FsWrite). It may thus only be used on the tokio threadpool. If the max_blocking number of backup threads is reached, and a blocking operation is required, then this implementation will appear full, with start_send returning Ok(AsyncSink::NotReady(chunk), until a backup thread becomes available or any timeout occurs.

Implementations

impl UniBodySink

pub fn new(body: BodySink, tune: Tunables) -> UniBodySink

Wrap by consuming a BodySink and Tunables instances.

Note: Both BodyImage and Tunables are Clone (inexpensive), so that can be done beforehand to preserve owned copies.

pub fn body(&self) -> &BodySink

The inner BodySink as constructed.

pub fn body_mut(&mut self) -> &mut BodySink

A mutable reference to the inner BodySink.

pub fn into_inner(self) -> BodySink

Unwrap and return the BodySink.

Trait Implementations

impl Debug for UniBodySink

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Sink for UniBodySink

type SinkItem = UniBodyBuf

The type of value that the sink accepts.

type SinkError = Error

The type of value produced by the sink when an error occurs.

fn start_send(&mut self, buf: UniBodyBuf) -> StartSend<UniBodyBuf, Flare>

Begin the process of sending a value to the sink.

fn poll_complete(&mut self) -> Poll<(), Flare>

Flush all output from this sink, if necessary.

fn close(&mut self) -> Poll<(), Flare>

A method to indicate that no more values will ever be pushed into this sink.

fn wait(self) -> Wait<Self>where
    Self: Sized,

Creates a new object which will produce a synchronous sink.

fn with<U, F, Fut>(self, f: F) -> With<Self, U, F, Fut>where
    F: FnMut(U) -> Fut,
    Fut: IntoFuture<Item = Self::SinkItem>,
    <Fut as IntoFuture>::Error: From<Self::SinkError>,
    Self: Sized,

Composes a function in front of the sink.

fn with_flat_map<U, F, St>(self, f: F) -> WithFlatMap<Self, U, F, St>where
    F: FnMut(U) -> St,
    St: Stream<Item = Self::SinkItem, Error = Self::SinkError>,
    Self: Sized,

Composes a function in front of the sink.

fn sink_map_err<F, E>(self, f: F) -> SinkMapErr<Self, F>where
    F: FnOnce(Self::SinkError) -> E,
    Self: Sized,

Transforms the error returned by the sink.

fn sink_from_err<E>(self) -> SinkFromErr<Self, E>where
    E: From<Self::SinkError>,
    Self: Sized,

Map this sink’s error to any error implementing From for this sink’s Error, returning a new sink.

fn buffer(self, amt: usize) -> Buffer<Self>where
    Self: Sized,

Adds a fixed-size buffer to the current sink.

fn flush(self) -> Flush<Self>where
    Self: Sized,

A future that completes when the sink has finished processing all pending requests.

fn send(self, item: Self::SinkItem) -> Send<Self>where
    Self: Sized,

A future that completes after the given item has been fully processed into the sink, including flushing.

fn send_all<S>(self, stream: S) -> SendAll<Self, S>where
    S: Stream<Item = Self::SinkItem>,
    Self::SinkError: From<<S as Stream>::Error>,
    Self: Sized,

A future that completes after the given stream has been fully processed into the sink, including flushing.