Struct bytecodec::io::WriteBuf

pub struct WriteBuf<B> { /* fields omitted */ }

Write buffer.

Implementations

impl<B: AsRef<[u8]> + AsMut<[u8]>> WriteBuf<B>

pub fn new(inner: B) -> Self

Makes a new WriteBuf instance.

pub fn len(&self) -> usize

Returns the number of encoded bytes in the buffer.

pub fn room(&self) -> usize

Returns the free space of the buffer.

Invariant: self.len() + self.room() <= self.capacity()

pub fn capacity(&self) -> usize

Returns the capacity of the buffer.

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty, otherwise false.

pub fn is_full(&self) -> bool

Returns true if the buffer is full, otherwise false.

pub fn stream_state(&self) -> StreamState

Returns the state of the stream that operated in the last flush() call.

pub fn stream_state_mut(&mut self) -> &mut StreamState

Returns a mutable reference to the StreamState instance.

pub fn flush<W: Write>(&mut self, writer: W) -> Result<()>

Writes the encoded bytes contained in this buffer to the given writer.

The written bytes will be removed from the buffer.

The flush process continues until one of the following condition is satisfied:

• The write buffer became empty
• A write operation returned a WouldBlock error
• The output stream has reached EOS

pub fn inner_ref(&self) -> &B

Returns a reference to the inner bytes of the buffer.

pub fn inner_mut(&mut self) -> &mut B

Returns a mutable reference to the inner bytes of the buffer.

pub fn into_inner(self) -> B

Takes ownership of ReadBuf and returns the inner bytes of the buffer.

impl<B: AsRef<[u8]> + AsMut<[u8]>> WriteBuf<B>

pub fn poll_flush<W: AsyncWrite>(
    &mut self,
    writer: Pin<&mut W>,
    cx: &mut Context<'_>
) -> Poll<Result<()>>

Writes the encoded bytes contained in this buffer to the given writer.

The written bytes will be removed from the buffer.

The flush process continues until one of the following condition is satisfied:

• The write buffer became empty
• A write operation returned a WouldBlock error
• The output stream has reached EOS

Trait Implementations

impl<B: Debug> Debug for WriteBuf<B>

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

Formats the value using the given formatter.

impl<B: AsRef<[u8]> + AsMut<[u8]>> Write for WriteBuf<B>

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

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

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

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 Writer 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.