Struct tokio_core::io::Framed

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

A unified Stream and Sink interface to an underlying Io object, using the Encode and Decode traits to encode and decode frames.

You can acquire a Framed instance by using the Io::framed adapter.

Methods

impl<T, C> Framed<T, C>

fn get_ref(&self) -> &T

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

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.

fn get_mut(&mut self) -> &mut T

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

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.

fn into_inner(self) -> T

Consumes the Framed, 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.

Trait Implementations

impl<T: Io, C: Codec> Stream for Framed<T, C>

type Item = C::In

The type of item this stream will yield on success.

type Error = Error

The type of error this stream may generate.

fn poll(&mut self) -> Poll<Option<C::In>, Error>

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

fn wait(self) -> Wait<Self>

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

fn boxed(self)
         -> Box<Stream<Error=Self::Error, Item=Self::Item> + 'static + Send> where Self: Send + 'static

Convenience function for turning this stream into a trait object.

fn into_future(self) -> StreamFuture<Self>

Converts this stream into a Future.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn collect(self) -> Collect<Self>

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

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::Error>

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

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

Flattens a stream of streams into just one continuous stream.

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>

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

fn for_each<F>(self, f: F) -> ForEach<Self, F> where F: FnMut(Self::Item) -> Result<(), Self::Error>

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

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

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

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

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

fn fuse(self) -> Fuse<Self>

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

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

Catches unwinding panics while polling the stream.

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

An adaptor for creating a buffered list of pending futures.

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

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

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

An adapter for merging the output of two streams.

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

An adapter for zipping two streams together.

fn peekable(self) -> Peekable<Self>

Creates a new stream which exposes a peek method.

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

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

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

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

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

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

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

Splits this Stream + Sink object into separate Stream and Sink objects, which can be useful when you want to split ownership between tasks, or allow direct interaction between the two objects (e.g. via Sink::send_all).

impl<T: Io, C: Codec> Sink for Framed<T, C>

type SinkItem = C::Out

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

Begin the process of sending a value to the sink.

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

Make progress on all pending requests, and determine whether they have completed.

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

Composes a function in front of the sink.

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

Adds a fixed-size buffer to the current sink.

fn flush(self) -> Flush<Self>

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

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

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::Error>

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