Struct futures_codec::FramedWrite

pub struct FramedWrite<T, E> { /* fields omitted */ }

A Sink of frames encoded to an AsyncWrite.

Example

#![feature(async_await, await_macro)]
use bytes::Bytes;
use futures_codec::{FramedWrite, BytesCodec};
use futures::{executor, SinkExt};

executor::block_on(async move {
    let mut buf = Vec::new();
    let mut framed = FramedWrite::new(&mut buf, BytesCodec {});
     
    let msg = Bytes::from("Hello World!");
    await!(framed.send(msg.clone())).unwrap();
     
    assert_eq!(&buf[..], &msg[..]);
})

Methods

impl<T, E> FramedWrite<T, E> where
    T: AsyncWrite,
    E: Encoder, 

pub fn new(inner: T, encoder: E) -> Self

Trait Implementations

impl<T, E> Sink<<E as Encoder>::Item> for FramedWrite<T, E> where
    T: AsyncWrite + Unpin,
    E: Encoder, 

type SinkError = E::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::SinkError>>

Attempts to prepare the Sink to receive a value.

fn start_send(
    self: Pin<&mut Self>,
    item: E::Item
) -> Result<(), Self::SinkError>

Begin the process of sending a value to the sink. Each call to this function must be proceeded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), Self::SinkError>>

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), Self::SinkError>>

Flush any remaining output and close this sink, if necessary.