Struct futures_ext::BytesStream

pub struct BytesStream<S> { /* fields omitted */ }

A structure that wraps a Stream of Bytes and lets it being accessed both as a Stream and as AsyncRead. It is very useful when decoding Stream of Bytes in an asynchronous way.

Implementations

impl<S: Stream<Item = Bytes>> BytesStream<S>

pub fn new(stream: S) -> Self

Create a new instance of BytesStream wrapping the given Stream of Bytes

pub fn is_empty(&self) -> bool

Returns true if there are no more bytes left to be consumed

pub fn into_parts(self) -> (Bytes, S)

Consumes this combinator returning a pair of bytes that have been received, but not yet consumed and the Stream that can possibly yield more bytes

pub fn into_future_decode<Dec>(self, decoder: Dec) -> BytesStreamFuture<S, Dec> where
    Dec: Decoder,
    Dec::Error: From<S::Error>, 

Returns a future that yields a single decoded item from the Bytes of this BytesStream (if any) and the remaining BytesStream.

pub fn prepend_bytes(&mut self, bytes: Bytes)

Adds some bytes to the front of the BytesStream internal buffer. Those bytes are ready to be read immediately after this function completes.

Trait Implementations

impl<S> AsyncRead for BytesStream<S> where
    S: Stream<Item = Bytes, Error = Error>, 

pub unsafe fn prepare_uninitialized_buffer(&self, buf: &mut [u8]) -> bool

Prepares an uninitialized buffer to be safe to pass to read. Returns true if the supplied buffer was zeroed out.

pub fn poll_read(&mut self, buf: &mut [u8]) -> Result<Async<usize>, Error>

Attempt to read from the AsyncRead into buf.

pub fn read_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
    B: BufMut, 

Pull some bytes from this source into the specified BufMut, returning how many bytes were read.

pub fn framed<T>(self, codec: T) -> Framed<Self, T> where
    Self: AsyncWrite,
    T: Decoder + Encoder, 

👎 Deprecated since 0.1.7:

Use tokio_codec::Decoder::framed instead

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

pub fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
    Self: AsyncWrite, 

Helper method for splitting this read/write object into two halves.

impl<S> BufRead for BytesStream<S> where
    S: Stream<Item = Bytes, Error = Error>, 

pub fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

pub fn consume(&mut self, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read.

pub fn read_until(
    &mut self,
    byte: u8,
    buf: &mut Vec<u8, Global>
) -> Result<usize, Error>

Read all bytes into buf until the delimiter byte or EOF is reached.

pub fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer.

pub fn split(self, byte: u8) -> Split<Self>

Returns an iterator over the contents of this reader split on the byte byte.

pub fn lines(self) -> Lines<Self>

Returns an iterator over the lines of this reader.

impl<S: Debug> Debug for BytesStream<S>

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S: Stream<Item = Bytes>> From<S> for BytesStream<S>

pub fn from(stream: S) -> Self

Performs the conversion.

impl<S> Read for BytesStream<S> where
    S: Stream<Item = Bytes, Error = Error>, 

pub fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

pub fn read_vectored(
    &mut self,
    bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

pub fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

pub unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

pub fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

pub fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

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

Creates an adaptor which will read at most limit bytes from it.