Struct WriteFramed

pub struct WriteFramed<T, C>(/* private fields */);

A Sink interface to WriteBuf object

Implementations

impl<T, C> WriteFramed<T, C>

pub fn get_ref(&self) -> &WriteBuf<T>

Returns a reference to the underlying I/O stream wrapped by WriteFramed.

pub fn get_mut(&mut self) -> &mut WriteBuf<T>

Returns a mutable reference to the underlying I/O stream wrapped by WriteFramed.

Note that care should be taken to not tamper with the underlying stream of data coming in as it may corrupt the stream of frames otherwise being worked with.

pub fn into_inner(self) -> WriteBuf<T>

Consumes the WriteFramed, returning its underlying I/O stream.

Note that stream may contain both input and output data buffered.

Trait Implementations

impl<T: AsyncWrite, C: Encode> Sink for WriteFramed<T, C>

type SinkItem = <C as Encode>::Item

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, item: C::Item) -> StartSend<C::Item, Error>

Begin the process of sending a value to the sink.

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

Flush all output from this sink, if necessary.

fn close(&mut self) -> Result<Async<()>, Self::SinkError>

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 fanout<S>(self, other: S) -> Fanout<Self, S>

where Self: Sized, Self::SinkItem: Clone, S: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,

Fanout items to multiple sinks.

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.