Struct body_image_futio::DispatchBodySink

#[must_use = "sinks do nothing unless polled"]
pub struct DispatchBodySink<B> where
    B: InputBuf,  { /* fields omitted */ }

Extends AsyncBodySink by further dispatching any blocking file write operations to a DispatchPool registered with the current thread.

The implementation will panic if a DispatchPool is not registered. Note that any risk of out-of-order writes (for example, via 2+ dispatch threads) is avoided, because each instance will have, at most, 1 pending dispatch write operation Future, that it drives to completion before accepting further input buffers. Also the underlying BodySink is owned for the life of the instance and is not a cloneable handle.

Trait Implementations

impl<B: Debug> Debug for DispatchBodySink<B> where
    B: InputBuf, 

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

Formats the value using the given formatter.

impl<B> Sink<B> for DispatchBodySink<B> where
    B: InputBuf, 

type Error = FutioError

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

fn poll_ready(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), FutioError>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, buf: B) -> Result<(), FutioError>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), FutioError>>

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), FutioError>>

Flush any remaining output and close this sink, if necessary.

impl<B> SinkWrapper<B> for DispatchBodySink<B> where
    B: InputBuf, 

fn new(body: BodySink, tune: FutioTunables) -> Self

Wrap by consuming a BodySink and FutioTunables instances.

fn into_inner(self) -> BodySink

Unwrap and return the BodySink.