Struct futures_util::io::line_writer::LineWriter

pub struct LineWriter<W: AsyncWrite> {
    buf_writer: BufWriter<W>,
}

Wrap a writer, like BufWriter does, but prioritizes buffering lines

This was written based on std::io::LineWriter which goes into further details explaining the code.

Buffering is actually done using BufWriter. This class will leverage BufWriter to write on-each-line.

Fields

buf_writer: BufWriter<W>

Implementations

impl<W: AsyncWrite> LineWriter<W>

pub fn new(inner: W) -> Self

Create a new LineWriter with default buffer capacity. The default is currently 1KB which was taken from std::io::LineWriter

pub fn with_capacity(capacity: usize, inner: W) -> Self

Creates a new LineWriter with the specified buffer capacity.

fn flush_if_completed_line( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<()>>

Flush buf_writer if last char is “new line”

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

Returns a reference to buf_writer’s internally buffered data.

pub fn get_ref(&self) -> &W

Acquires a reference to the underlying sink or stream that this combinator is pulling from.

Trait Implementations

impl<W: AsyncWrite> AsyncWrite for LineWriter<W>

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

Forward to buf_writer ’s BufWriter::poll_flush()

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

Forward to buf_writer ’s BufWriter::poll_close()

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

Attempt to write bytes from buf into the object.

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

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

impl<W: Debug + AsyncWrite> Debug for LineWriter<W>

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

Formats the value using the given formatter.

impl<'__pin, W: AsyncWrite> Unpin for LineWriter<W>

where PinnedFieldsOf<__Origin<'__pin, W>>: Unpin,