Struct transmog_async::TransmogReader

pub struct TransmogReader<R, T, F> { /* private fields */ }

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

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

Note that the sender must prefix each serialized item with its size encoded using ordered-varint.

Implementations

impl<R, T, F> TransmogReader<R, T, F>

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 TransmogReader, returning the underlying reader.

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

impl<R, T, F> TransmogReader<R, T, F>

pub fn new(reader: R, format: F) -> Self

Returns a new instance that reads format-encoded data for reader.

pub fn default_for(format: F) -> Self where
    R: Default, 

Returns a new instance that reads format-encoded data for R::default().

Trait Implementations

impl<R: Debug, T: Debug, F: Debug> Debug for TransmogReader<R, T, F>

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

Formats the value using the given formatter.

impl<R, T, F> Stream for TransmogReader<R, T, F> where
    R: AsyncRead + Unpin,
    F: OwnedDeserializer<T>, 

type Item = Result<T, F::Error>

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, F> Unpin for TransmogReader<R, T, F> where
    R: Unpin,