Struct tokio_io::codec::Framed [] [src]

pub struct Framed<T, U> { /* fields omitted */ }

A unified Stream and Sink interface to an underlying I/O object, using the Encoder and Decoder traits to encode and decode frames.

You can create a Framed instance by using the AsyncRead::framed adapter.

Methods

impl<T, U> Framed<T, U>
[src]

[src]

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

Raw I/O objects work with byte sequences, but higher-level code usually wants to batch these into meaningful chunks, called "frames". This method layers framing on top of an I/O object, by using the Codec traits to handle encoding and decoding of messages frames. Note that the incoming and outgoing frame types may be distinct.

This function returns a single object that is both Stream and Sink; grouping this into a single object is often useful for layering things like gzip or TLS, which require both read and write access to the underlying object.

This objects takes a stream and a readbuffer and a writebuffer. These field can be obtained from an existing Framed with the into_parts method.

If you want to work more directly with the streams and sink, consider calling split on the Framed returned by this method, which will break them into separate objects, allowing them to interact more easily.

[src]

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

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.

[src]

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

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.

[src]

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

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.

[src]

Consumes the Frame, returning its underlying I/O stream and the buffer with unprocessed data.

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.

[src]

Consumes the Frame, returning its underlying I/O stream and the buffer with unprocessed data, and also the current codec state.

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.

Note that this function will be removed once the codec has been integrated into FramedParts in a new version (see #53).

Trait Implementations

impl<T, U> Stream for Framed<T, U> where
    T: AsyncRead,
    U: Decoder
[src]

The type of item this stream will yield on success.

The type of error this stream may generate.

[src]

Attempt to pull out the next value of this stream, returning None if the stream is finished. Read more

[src]

Creates an iterator which blocks the current thread until each item of this stream is resolved. Read more

[src]

Converts this stream into a Future. Read more

[src]

Converts a stream of type T to a stream of type U. Read more

[src]

Converts a stream of error type T to a stream of error type U. Read more

[src]

Filters the values produced by this stream according to the provided predicate. Read more

[src]

Filters the values produced by this stream while simultaneously mapping them to a different type. Read more

[src]

Chain on a computation for when a value is ready, passing the resulting item to the provided closure f. Read more

[src]

Chain on a computation for when a value is ready, passing the successful results to the provided closure f. Read more

[src]

Chain on a computation for when an error happens, passing the erroneous result to the provided closure f. Read more

[src]

Collect all of the values of this stream into a vector, returning a future representing the result of that computation. Read more

[src]

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. Read more

[src]

Deprecated since 0.1.14

: please use Stream::concat2 instead

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. Read more

[src]

Execute an accumulating computation over a stream, collecting all the values into one final result. Read more

[src]

Flattens a stream of streams into just one continuous stream. Read more

[src]

Skip elements on this stream while the predicate provided resolves to true. Read more

[src]

Take elements from this stream while the predicate provided resolves to true. Read more

[src]

Runs this stream to completion, executing the provided closure for each element on the stream. Read more

[src]

Map this stream's error to any error implementing From for this stream's Error, returning a new stream. Read more

[src]

Creates a new stream of at most amt items of the underlying stream. Read more

[src]

Creates a new stream which skips amt items of the underlying stream. Read more

[src]

Fuse a stream such that poll will never again be called once it has finished. Read more

[src]

Borrows a stream, rather than consuming it. Read more

[src]

Catches unwinding panics while polling the stream. Read more

[src]

An adaptor for creating a buffered list of pending futures. Read more

[src]

An adaptor for creating a buffered list of pending futures (unordered). Read more

[src]

Deprecated

: functionality provided by select now

An adapter for merging the output of two streams. Read more

[src]

An adapter for zipping two streams together. Read more

[src]

Adapter for chaining two stream. Read more

[src]

Creates a new stream which exposes a peek method. Read more

[src]

An adaptor for chunking up items of the stream inside a vector. Read more

[src]

Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first. Read more

[src]

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

[src]

Splits this Stream + Sink object into separate Stream and Sink objects. Read more

[src]

Do something with each item of this stream, afterwards passing it on. Read more

impl<T, U> Sink for Framed<T, U> where
    T: AsyncWrite,
    U: Encoder,
    U::Error: From<Error>, 
[src]

The type of value that the sink accepts.

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

[src]

Begin the process of sending a value to the sink. Read more

[src]

Flush all output from this sink, if necessary. Read more

[src]

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

[src]

Creates a new object which will produce a synchronous sink. Read more

[src]

Composes a function in front of the sink. Read more

[src]

Composes a function in front of the sink. Read more

[src]

Transforms the error returned by the sink.

[src]

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

[src]

Adds a fixed-size buffer to the current sink. Read more

[src]

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

[src]

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

[src]

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

impl<T, U> Debug for Framed<T, U> where
    T: Debug,
    U: Debug
[src]

[src]

Formats the value using the given formatter.