Struct BytesStream 

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

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>,

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.

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

Attempt to read from the AsyncRead into buf.

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

where B: BufMut, Self: Sized,

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

impl<S> BufRead for BytesStream<S>

where S: Stream<Item = Bytes, Error = Error>,

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

Returns the contents of the internal buffer, filling it with more data, via Read methods, if empty.

fn consume(&mut self, amt: usize)

Marks the given amount of additional bytes from the internal buffer as having been read. Subsequent calls to read only return bytes that have not been marked as read.

fn has_data_left(&mut self) -> Result<bool, Error>

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

Checks if there is any data left to be read.

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

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

fn skip_until(&mut self, byte: u8) -> Result<usize, Error>

Skips all bytes until the delimiter byte or EOF is reached.

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

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

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

where Self: Sized,

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

fn lines(self) -> Lines<Self>

where Self: Sized,

Returns an iterator over the lines of this reader.

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

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

Formats the value using the given formatter.

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

fn from(stream: S) -> Self

Converts to this type from the input type.

impl<S> Read for BytesStream<S>

where S: Stream<Item = Bytes, Error = Error>,

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.

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

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

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.

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

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

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

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

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

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

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

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

where Self: Sized,

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