Struct twitchchat::AsyncEncoder

pub struct AsyncEncoder<W> { /* fields omitted */ }

This is supported on crate feature async only.

An asynchronous encoder.

Implementations

impl<W> AsyncEncoder<W> where
    W: Write + Send + Sync, 

pub fn encode_sync<M>(&mut self, msg: M) -> IoResult<()> where
    M: Encodable + Send + Sync, 

If the wrapped writer is synchronous, you can use this method to encode the message to it.

impl<W> AsyncEncoder<W> where
    W: AsyncWrite + Send + Sync + Unpin, 

pub fn new(writer: W) -> Self

Create a new Encoder over this futures_lite::AsyncWrite instance

pub async fn into_inner(__arg0: Self) -> IoResult<W>

Get the inner futures_lite::AsyncWrite instance out

This writes and flushes any buffered data before it consumes self.

pub async fn encode<M, '_>(&'_ mut self, msg: M) -> IoResult<()> where
    M: Encodable + Send + Sync,
    W: Unpin, 

Encode this Encodable message to the writer.

This flushes the data before returning

Trait Implementations

impl<W> AsyncWrite for AsyncEncoder<W> where
    W: AsyncWrite + Unpin + Send + Sync, 

fn poll_write(
    self: Pin<&mut Self>,
    ctx: &mut Context<'_>,
    buf: &[u8]
) -> Poll<IoResult<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<IoResult<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<IoResult<()>>

Attempt to close the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<W> Clone for AsyncEncoder<W> where
    W: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<W> Debug for AsyncEncoder<W>

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

Formats the value using the given formatter.

impl<W> Write for AsyncEncoder<W> where
    W: Write + Send + Sync, 

fn write(&mut self, buf: &[u8]) -> IoResult<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> IoResult<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writeer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

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