[−][src]Struct futures_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.

Example

#![feature(async_await)]
use bytes::Bytes;
use futures::{executor, SinkExt, TryStreamExt};
use futures::io::Cursor;
use futures_codec::{BytesCodec, Framed};

executor::block_on(async move {
    let cur = Cursor::new(vec![0u8; 12]);
    let mut framed = Framed::new(cur, BytesCodec {});

    // Send bytes to `buf` through the `BytesCodec`
    let bytes = Bytes::from("Hello world!");
    framed.send(bytes).await.unwrap();

    // Dispose of the framer and return the I/O and codec
    let (cur, _) = framed.release();
    assert_eq!(cur.get_ref(), b"Hello world!");
})

Methods

`impl<T, U> Framed<T, U> where T: AsyncRead + AsyncWrite, U: Decoder + Encoder,` [src]

`pub fn new(inner: T, codec: U) -> Self`[src]

Creates a new Framed transport with the given codec. A codec is a type which implements Decoder and Encoder.

`pub fn release(self) -> (T, U)`[src]

Release the I/O and Codec

Trait Implementations

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

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl<T, U> Deref for Framed<T, U>`[src]

`type Target = T`

The resulting type after dereferencing.

`fn deref(&self) -> &T`[src]

`impl<T, U> DerefMut for Framed<T, U>`[src]

`fn deref_mut(&mut self) -> &mut T`[src]

`impl<T, U> Sink<::Item> for Framed<T, U> where T: AsyncWrite + Unpin, U: Encoder,` [src]

`type Error = U::Error`

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

`fn poll_ready( self: Pin<&mut Self>, cx: &mut Context ) -> Poll<Result<(), Self::Error>>`[src]

`fn start_send(self: Pin<&mut Self>, item: U::Item) -> Result<(), Self::Error>`[src]

`fn poll_flush( self: Pin<&mut Self>, cx: &mut Context ) -> Poll<Result<(), Self::Error>>`[src]

`fn poll_close( self: Pin<&mut Self>, cx: &mut Context ) -> Poll<Result<(), Self::Error>>`[src]

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

`type Item = Result<U::Item, U::Error>`

Values yielded by the stream.

`fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>`[src]

`fn size_hint(&self) -> (usize, Option<usize>)`[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,`

`impl<T, U> Unpin for Framed<T, U>`

`impl<T, U> UnwindSafe for Framed<T, U> where T: UnwindSafe, U: UnwindSafe,`

`impl<T, U> RefUnwindSafe for Framed<T, U> where T: RefUnwindSafe, U: RefUnwindSafe,`

Blanket Implementations

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

`fn into(self) -> U`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> 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.

`fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

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

`type Error = >::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`[src]

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

`fn borrow(&self) -> &T`[src]

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

`fn borrow_mut(&mut self) -> &mut T`[src]

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

`fn type_id(&self) -> TypeId`[src]

`impl<S, T, E> TryStream for S where S: Stream<Item = Result<T, E>> + ?Sized,` [src]

`type Ok = T`

The type of successful values yielded by this future

`type Error = E`

The type of failures yielded by this future

`fn try_poll_next( self: Pin<&mut S>, cx: &mut Context ) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>`[src]

`impl<T> StreamExt for T where T: Stream + ?Sized,` [src]

`fn next(&mut self) -> Next<Self> where Self: Unpin,` [src]

`fn into_future(self) -> StreamFuture<Self> where Self: Unpin,` [src]

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

`fn enumerate(self) -> Enumerate<Self>`[src]

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

`fn filter_map<Fut, T, F>(self, f: F) -> FilterMap<Self, Fut, F> where F: FnMut(Self::Item) -> Fut, Fut: Future<Output = Option<T>>,` [src]

`fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where F: FnMut(Self::Item) -> Fut, Fut: Future,` [src]

`fn collect<C>(self) -> Collect<Self, C> where C: Default + Extend<Self::Item>,` [src]

`fn concat(self) -> Concat<Self> where Self::Item: Extend<<Self::Item as IntoIterator>::Item>, Self::Item: IntoIterator, Self::Item: Default,` [src]

`fn fold<T, Fut, F>(self, init: T, f: F) -> Fold<Self, Fut, T, F> where F: FnMut(T, Self::Item) -> Fut, Fut: Future<Output = T>,` [src]

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

`fn skip_while<Fut, F>(self, f: F) -> SkipWhile<Self, Fut, F> where F: FnMut(&Self::Item) -> Fut, Fut: Future<Output = bool>,` [src]

`fn take_while<Fut, F>(self, f: F) -> TakeWhile<Self, Fut, F> where F: FnMut(&Self::Item) -> Fut, Fut: Future<Output = bool>,` [src]

`fn for_each<Fut, F>(self, f: F) -> ForEach<Self, Fut, F> where F: FnMut(Self::Item) -> Fut, Fut: Future<Output = ()>,` [src]

`fn for_each_concurrent<Fut, F>( self, limit: impl Into<Option<usize>>, f: F ) -> ForEachConcurrent<Self, Fut, F> where F: FnMut(Self::Item) -> Fut, Fut: Future<Output = ()>,` [src]

`fn take(self, n: usize) -> Take<Self>`[src]

`fn skip(self, n: usize) -> Skip<Self>`[src]

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

`fn by_ref(&mut self) -> &mut Self`[src]

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

`fn boxed<'a>(self) -> Pin<Box<dyn Stream<Item = Self::Item> + 'a + Send>> where Self: Send + 'a,` [src]

`fn boxed_local<'a>(self) -> Pin<Box<dyn Stream<Item = Self::Item> + 'a>> where Self: 'a,` [src]

`fn buffered(self, n: usize) -> Buffered<Self> where Self::Item: Future,` [src]

`fn buffer_unordered(self, n: usize) -> BufferUnordered<Self> where Self::Item: Future,` [src]

`fn zip<St>(self, other: St) -> Zip<Self, St> where St: Stream,` [src]

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

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

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

`fn forward<S>(self, sink: S) -> Forward<Self, S> where S: Sink<Self::Ok>, Self: TryStream<Error = <S as Sink<Self::Ok>>::Error>,` [src]

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

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

`fn left_stream(self) -> Either<Self, B> where B: Stream<Item = Self::Item>,` [src]

`fn right_stream(self) -> Either<B, Self> where B: Stream<Item = Self::Item>,` [src]

`fn poll_next_unpin(&mut self, cx: &mut Context) -> Poll<Option<Self::Item>> where Self: Unpin,` [src]

`fn select_next_some(&mut self) -> SelectNextSome<Self> where Self: Unpin + FusedStream,` [src]

`impl<S> TryStreamExt for S where S: TryStream + ?Sized,` [src]

`fn err_into<E>(self) -> ErrInto<Self, E> where Self::Error: Into<E>,` [src]

`fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where F: FnMut(Self::Ok) -> T,` [src]

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

`fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where F: FnMut(Self::Ok) -> Fut, Fut: TryFuture<Error = Self::Error>,` [src]

`fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where F: FnMut(Self::Error) -> Fut, Fut: TryFuture<Ok = Self::Ok>,` [src]

`fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where F: FnMut(&Self::Ok),` [src]

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

`fn into_stream(self) -> IntoStream<Self>`[src]

`fn try_next(&mut self) -> TryNext<Self> where Self: Unpin,` [src]

`fn try_for_each<Fut, F>(self, f: F) -> TryForEach<Self, Fut, F> where F: FnMut(Self::Ok) -> Fut, Fut: TryFuture<Ok = (), Error = Self::Error>,` [src]

`fn try_skip_while<Fut, F>(self, f: F) -> TrySkipWhile<Self, Fut, F> where F: FnMut(&Self::Ok) -> Fut, Fut: TryFuture<Ok = bool, Error = Self::Error>,` [src]

`fn try_for_each_concurrent<Fut, F>( self, limit: impl Into<Option<usize>>, f: F ) -> TryForEachConcurrent<Self, Fut, F> where F: FnMut(Self::Ok) -> Fut, Fut: Future<Output = Result<(), Self::Error>>,` [src]

`fn try_collect<C>(self) -> TryCollect<Self, C> where C: Default + Extend<Self::Ok>,` [src]

`fn try_filter<Fut, F>(self, f: F) -> TryFilter<Self, Fut, F> where F: FnMut(&Self::Ok) -> Fut, Fut: Future<Output = bool>,` [src]

`fn try_filter_map<Fut, F, T>(self, f: F) -> TryFilterMap<Self, Fut, F> where F: FnMut(Self::Ok) -> Fut, Fut: TryFuture<Ok = Option<T>, Error = Self::Error>,` [src]

`fn try_flatten(self) -> TryFlatten<Self> where Self::Ok: TryStream, <Self::Ok as TryStream>::Error: From<Self::Error>,` [src]

`fn try_fold<T, Fut, F>(self, init: T, f: F) -> TryFold<Self, Fut, T, F> where F: FnMut(T, Self::Ok) -> Fut, Fut: TryFuture<Ok = T, Error = Self::Error>,` [src]

`fn try_concat(self) -> TryConcat<Self> where Self::Ok: Extend<<Self::Ok as IntoIterator>::Item>, Self::Ok: IntoIterator, Self::Ok: Default,` [src]

`fn try_buffer_unordered(self, n: usize) -> TryBufferUnordered<Self> where Self::Ok: TryFuture, <Self::Ok as TryFuture>::Error == Self::Error,` [src]

`fn try_poll_next_unpin( &mut self, cx: &mut Context ) -> Poll<Option<Result<Self::Ok, Self::Error>>> where Self: Unpin,` [src]

`fn into_async_read(self) -> IntoAsyncRead<Self> where Self: TryStreamExt<Error = Error> + Unpin, Self::Ok: AsRef<[u8]>,` [src]

`impl<T, Item> SinkExt<Item> for T where T: Sink<Item> + ?Sized,` [src]

`fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where E: From<Self::Error>, F: FnMut(U) -> Fut, Fut: Future<Output = Result<Item, E>>,` [src]

`fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F> where F: FnMut(U) -> St, St: Stream<Item = Result<Item, Self::Error>>,` [src]

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

`fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where Self::Error: Into<E>,` [src]

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

`fn close(&mut self) -> Close<Self, Item> where Self: Unpin,` [src]

`fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where Item: Clone, Si: Sink<Item, Error = Self::Error>,` [src]

`fn flush(&mut self) -> Flush<Self, Item> where Self: Unpin,` [src]

`fn send(&mut self, item: Item) -> Send<Self, Item> where Self: Unpin,` [src]

`fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where Self: Unpin, St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,` [src]

`fn left_sink<Si2>(self) -> Either<Self, Si2> where Si2: Sink<Item, Error = Self::Error>,` [src]

`fn right_sink<Si1>(self) -> Either<Si1, Self> where Si1: Sink<Item, Error = Self::Error>,` [src]

[−][src]Struct futures_codec::Framed

Example

Methods

impl<T, U> Framed<T, U> where T: AsyncRead + AsyncWrite, U: Decoder + Encoder, [src]

pub fn new(inner: T, codec: U) -> Self[src]

pub fn release(self) -> (T, U)[src]

Trait Implementations

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

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

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

type Target = T

fn deref(&self) -> &T[src]

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

fn deref_mut(&mut self) -> &mut T[src]

impl<T, U> Sink<<U as Encoder>::Item> for Framed<T, U> where T: AsyncWrite + Unpin, U: Encoder, [src]

type Error = U::Error

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<(), Self::Error>>[src]

fn start_send(self: Pin<&mut Self>, item: U::Item) -> Result<(), Self::Error>[src]

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<(), Self::Error>>[src]

fn poll_close( self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<(), Self::Error>>[src]

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

type Item = Result<U::Item, U::Error>

fn poll_next(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>>[src]

fn size_hint(&self) -> (usize, Option<usize>)[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,

impl<T, U> Unpin for Framed<T, U>

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

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

Blanket Implementations

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

fn into(self) -> U[src]

impl<T> From<T> for T[src]

fn from(t: T) -> T[src]

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

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

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

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

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

fn borrow(&self) -> &T[src]

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

fn borrow_mut(&mut self) -> &mut T[src]

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

fn type_id(&self) -> TypeId[src]

impl<S, T, E> TryStream for S where S: Stream<Item = Result<T, E>> + ?Sized, [src]

type Ok = T

type Error = E

fn try_poll_next( self: Pin<&mut S>, cx: &mut Context) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>[src]

impl<T> StreamExt for T where T: Stream + ?Sized, [src]

fn next(&mut self) -> Next<Self> where Self: Unpin, [src]

fn into_future(self) -> StreamFuture<Self> where Self: Unpin, [src]

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

fn enumerate(self) -> Enumerate<Self>[src]

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

fn filter_map<Fut, T, F>(self, f: F) -> FilterMap<Self, Fut, F> where F: FnMut(Self::Item) -> Fut, Fut: Future<Output = Option<T>>, [src]

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where F: FnMut(Self::Item) -> Fut, Fut: Future, [src]

fn collect<C>(self) -> Collect<Self, C> where C: Default + Extend<Self::Item>, [src]

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

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

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

fn skip_while<Fut, F>(self, f: F) -> SkipWhile<Self, Fut, F> where F: FnMut(&Self::Item) -> Fut, Fut: Future<Output = bool>, [src]

fn take_while<Fut, F>(self, f: F) -> TakeWhile<Self, Fut, F> where F: FnMut(&Self::Item) -> Fut, Fut: Future<Output = bool>, [src]

fn for_each<Fut, F>(self, f: F) -> ForEach<Self, Fut, F> where F: FnMut(Self::Item) -> Fut, Fut: Future<Output = ()>, [src]

fn for_each_concurrent<Fut, F>( self, limit: impl Into<Option<usize>>, f: F) -> ForEachConcurrent<Self, Fut, F> where F: FnMut(Self::Item) -> Fut, Fut: Future<Output = ()>, [src]

fn take(self, n: usize) -> Take<Self>[src]

fn skip(self, n: usize) -> Skip<Self>[src]

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

fn by_ref(&mut self) -> &mut Self[src]

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

fn boxed<'a>(self) -> Pin<Box<dyn Stream<Item = Self::Item> + 'a + Send>> where Self: Send + 'a, [src]

fn boxed_local<'a>(self) -> Pin<Box<dyn Stream<Item = Self::Item> + 'a>> where Self: 'a, [src]

fn buffered(self, n: usize) -> Buffered<Self> where Self::Item: Future, [src]

fn buffer_unordered(self, n: usize) -> BufferUnordered<Self> where Self::Item: Future, [src]

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

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

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

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