[][src]Struct tokio::codec::Framed

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> where
    T: AsyncRead + AsyncWrite,
    U: Decoder + Encoder
[src]

pub fn new(inner: T, codec: U) -> Framed<T, U>[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.

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.

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

pub fn from_parts(parts: FramedParts<T, U>) -> Framed<T, U>[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.

Important traits for &'_ mut R
pub fn get_ref(&self) -> &T[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.

Important traits for &'_ mut R
pub fn get_mut(&mut self) -> &mut T[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.

Important traits for &'_ mut R
pub fn codec(&self) -> &U[src]

Returns a reference to the underlying codec wrapped by Frame.

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

Important traits for &'_ mut R
pub fn codec_mut(&mut self) -> &mut U[src]

Returns a mutable reference to the underlying codec wrapped by Frame.

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

pub fn into_inner(self) -> T[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.

pub fn into_parts(self) -> FramedParts<T, U>[src]

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

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.

Trait Implementations

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

type Item = <U as Decoder>::Item

The type of item this stream will yield on success.

type Error = <U as Decoder>::Error

The type of error this stream may generate.

Important traits for Wait<S>
fn wait(self) -> Wait<Self>[src]

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

fn into_future(self) -> StreamFuture<Self>[src]

Converts this stream into a Future. Read more

fn map<U, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> U, 
[src]

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

fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where
    F: FnMut(Self::Error) -> U, 
[src]

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

fn filter<F>(self, f: F) -> Filter<Self, F> where
    F: FnMut(&Self::Item) -> bool
[src]

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

fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>, 
[src]

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

fn then<F, U>(self, f: F) -> Then<Self, F, U> where
    F: FnMut(Result<Self::Item, Self::Error>) -> U,
    U: IntoFuture
[src]

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

fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U> where
    F: FnMut(Self::Item) -> U,
    U: IntoFuture<Error = Self::Error>, 
[src]

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

fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U> where
    F: FnMut(Self::Error) -> U,
    U: IntoFuture<Item = Self::Item>, 
[src]

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

fn collect(self) -> Collect<Self>[src]

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

fn concat2(self) -> Concat2<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator,
    Self::Item: Default
[src]

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

fn concat(self) -> Concat<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator
[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

fn fold<F, T, Fut>(self, init: T, f: F) -> Fold<Self, F, Fut, T> where
    F: FnMut(T, Self::Item) -> Fut,
    Fut: IntoFuture<Item = T>,
    Self::Error: From<<Fut as IntoFuture>::Error>, 
[src]

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

fn flatten(self) -> Flatten<Self> where
    Self::Item: Stream,
    <Self::Item as Stream>::Error: From<Self::Error>, 
[src]

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

fn skip_while<P, R>(self, pred: P) -> SkipWhile<Self, P, R> where
    P: FnMut(&Self::Item) -> R,
    R: IntoFuture<Item = bool, Error = Self::Error>, 
[src]

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

fn take_while<P, R>(self, pred: P) -> TakeWhile<Self, P, R> where
    P: FnMut(&Self::Item) -> R,
    R: IntoFuture<Item = bool, Error = Self::Error>, 
[src]

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

fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U> where
    F: FnMut(Self::Item) -> U,
    U: IntoFuture<Item = (), Error = Self::Error>, 
[src]

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

fn from_err<E>(self) -> FromErr<Self, E> where
    E: From<Self::Error>, 
[src]

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

fn take(self, amt: u64) -> Take<Self>[src]

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

fn skip(self, amt: u64) -> Skip<Self>[src]

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

fn fuse(self) -> Fuse<Self>[src]

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

Important traits for &'_ mut R
fn by_ref(&mut self) -> &mut Self[src]

Borrows a stream, rather than consuming it. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe
[src]

Catches unwinding panics while polling the stream. Read more

fn buffered(self, amt: usize) -> Buffered<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error == Self::Error
[src]

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

fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error == Self::Error
[src]

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

fn merge<S>(self, other: S) -> Merge<Self, S> where
    S: Stream<Error = Self::Error>, 
[src]

Deprecated:

functionality provided by select now

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

fn zip<S>(self, other: S) -> Zip<Self, S> where
    S: Stream<Error = Self::Error>, 
[src]

An adapter for zipping two streams together. Read more

fn chain<S>(self, other: S) -> Chain<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>, 
[src]

Adapter for chaining two stream. Read more

fn peekable(self) -> Peekable<Self>[src]

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

fn chunks(self, capacity: usize) -> Chunks<Self>[src]

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

fn select<S>(self, other: S) -> Select<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>, 
[src]

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

fn forward<S>(self, sink: S) -> Forward<Self, S> where
    S: Sink<SinkItem = Self::Item>,
    Self::Error: From<<S as Sink>::SinkError>, 
[src]

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

fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where
    Self: Sink
[src]

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

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), 
[src]

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

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
    F: FnMut(&Self::Error), 
[src]

Do something with the error of this stream, afterwards passing it on. Read more

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

type SinkItem = <U as Encoder>::Item

The type of value that the sink accepts.

type SinkError = <U as Encoder>::Error

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

fn wait(self) -> Wait<Self>[src]

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

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>, 
[src]

Composes a function in front of the sink. Read more

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>, 
[src]

Composes a function in front of the sink. Read more

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

Transforms the error returned by the sink.

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

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

fn buffer(self, amt: usize) -> Buffer<Self>[src]

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

fn fanout<S>(self, other: S) -> Fanout<Self, S> where
    S: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
    Self::SinkItem: Clone
[src]

Fanout items to multiple sinks. Read more

fn flush(self) -> Flush<Self>[src]

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

fn send(self, item: Self::SinkItem) -> Send<Self>[src]

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

fn send_all<S>(self, stream: S) -> SendAll<Self, S> where
    S: Stream<Item = Self::SinkItem>,
    Self::SinkError: From<<S as Stream>::Error>, 
[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]

Auto Trait Implementations

impl<T, U> Send for Framed<T, U> where
    T: Send,
    U: Send

impl<T, U> Sync for Framed<T, U> where
    T: Sync,
    U: Sync

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> From for T[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Erased for T