Struct async_bincode::futures::AsyncBincodeReader

pub struct AsyncBincodeReader<R, T>(_);

A wrapper around an asynchronous reader that produces an asynchronous stream of bincode-decoded values.

To use, provide a reader that implements futures_io::AsyncRead, and then use futures_core::Stream to access the deserialized values.

Note that the sender must prefix each serialized item with its size as reported by bincode::serialized_size encoded as a four-byte network-endian encoded. See also [serialize_into], which does this for you.

Implementations

impl<R, T> AsyncBincodeReader<R, T>

pub fn get_ref(&self) -> &R

Gets a reference to the underlying reader.

It is inadvisable to directly read from the underlying reader.

pub fn get_mut(&mut self) -> &mut R

Gets a mutable reference to the underlying reader.

It is inadvisable to directly read from the underlying reader.

pub fn buffer(&self) -> &[u8]

Returns a reference to the internally buffered data.

This will not attempt to fill the buffer if it is empty.

pub fn into_inner(self) -> R

Unwraps this AsyncBincodeReader, returning the underlying reader.

Note that any leftover data in the internal buffer is lost.

Trait Implementations

impl<R: Debug, T: Debug> Debug for AsyncBincodeReader<R, T>

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

Formats the value using the given formatter.

impl<R, T> Default for AsyncBincodeReader<R, T> where
    R: Default, 

fn default() -> Self

Returns the “default value” for a type.

impl<R, T> From<R> for AsyncBincodeReader<R, T>

fn from(reader: R) -> Self

Converts to this type from the input type.

impl<R, T> Stream for AsyncBincodeReader<R, T> where
    for<'a> T: Deserialize<'a>,
    R: AsyncRead + Unpin, 

type Item = Result<T, Box<ErrorKind, Global>>

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<R, T> Unpin for AsyncBincodeReader<R, T> where
    R: Unpin,