Struct buf_redux::LineWriter

pub struct LineWriter<W: Write>(_);

A drop-in replacement for std::io::LineWriter with more functionality.

Methods

impl<W: Write> LineWriter<W>

fn new(inner: W) -> Self

Wrap inner with the default buffer capacity.

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

Wrap inner with the given buffer capacity.

fn get_ref(&self) -> &W

Get a reference to the inner writer.

fn get_mut(&mut self) -> &mut W

Get a mutable reference to the inner writer.

Note

If the buffer has not been flushed, writing directly to the inner type will cause data inconsistency.

fn capacity(&self) -> usize

Get the capacty of the inner buffer.

fn buffered(&self) -> usize

Get the number of bytes currently in the buffer.

fn grow(&mut self, additional: usize)

Grow the internal buffer by at least additional bytes. May not be quite exact due to implementation details of the buffer's allocator.

Note

This should not be called frequently as each call will incur a reallocation.

fn into_inner(self) -> Result<W, IntoInnerError<Self>>

Flush the buffer and unwrap, returning the inner writer on success, or a type wrapping self plus the error otherwise.

fn into_inner_with_err(self) -> (W, Option<Error>)

Flush the buffer and unwrap, returning the inner writer and any error encountered during flushing.

fn into_inner_with_buf(self) -> (W, Vec<u8>)

Consume self and return both the underlying writer and the buffer, with the data moved to the beginning and the length truncated to contain only valid data.

Trait Implementations

impl<W: Write> Write for LineWriter<W>

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

Write a buffer into this object, 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_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this write.

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.

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

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

Formats the value using the given formatter.