Struct twitchchat::AsyncDecoder

pub struct AsyncDecoder<R> { /* fields omitted */ }

This is supported on crate feature async only.

A decoder over futures_lite::AsyncRead that produces IrcMessages

This will return an DecodeError::Eof when its done reading manually.

When reading it as a stream, Eof will signal the end of the stream (e.g. None)

Implementations

impl<R: AsyncRead + Send + Sync + Unpin> AsyncDecoder<R>

pub fn new(reader: R) -> Self

Create a new AsyncDecoder from this futures_lite::AsyncRead instance

pub async fn read_message<'_, '_>(
    &'_ mut self
) -> Result<IrcMessage<'_>, DecodeError>

Read the next message.

This returns a borrowed IrcMessage which is valid until the next AsyncDecoder call is made.

If you just want an owned one, use the AsyncDecoder as an stream. e.g. dec.next().

pub fn into_inner(self) -> R

Consume the decoder returning the inner Reader

Trait Implementations

impl<R> Debug for AsyncDecoder<R>

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

Formats the value using the given formatter.

impl<R> Stream for AsyncDecoder<R> where
    R: AsyncRead + Send + Sync + Unpin, 

This will produce Result<IrcMessage<'static>, DecodeError> until an Eof is received

type Item = Result<IrcMessage<'static>, DecodeError>

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.