Struct tabwriter::TabWriter

pub struct TabWriter<W> { /* private fields */ }

TabWriter wraps an arbitrary writer and aligns tabbed output.

Elastic tabstops work by aligning contiguous tabbed delimited fields known as column blocks. When a line appears that breaks all contiguous blocks, all buffered output will be flushed to the underlying writer. Otherwise, output will stay buffered until flush is explicitly called.

Implementations

impl<W: Write> TabWriter<W>

pub fn new(w: W) -> TabWriter<W>

Create a new TabWriter from an existing Writer.

All output written to Writer is passed through TabWriter. Contiguous column blocks indicated by tabs are aligned.

Note that flush must be called to guarantee that TabWriter will write to the given writer.

pub fn minwidth(self, minwidth: usize) -> TabWriter<W>

Set the minimum width of each column. That is, all columns will have at least the size given here. If a column is smaller than minwidth, then it is padded with spaces.

The default minimum width is 2.

pub fn padding(self, padding: usize) -> TabWriter<W>

Set the padding between columns. All columns will be separated by at least the number of spaces indicated by padding. If padding is zero, then columns may run up against each other without any separation.

The default padding is 2.

pub fn alignment(self, alignment: Alignment) -> TabWriter<W>

Set the alignment of text within cells. This will effect future flushes.

The default alignment is Alignment::Left.

pub fn ansi(self, yes: bool) -> TabWriter<W>

Ignore ANSI escape codes when computing the number of display columns.

This is disabled by default. (But is enabled by default when the deprecated ansi_formatting crate feature is enabled.)

pub fn tab_indent(self, yes: bool) -> TabWriter<W>

Always use tabs for indentation columns (i.e., padding of leading empty cells on the left).

This is disabled by default.

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

Unwraps this TabWriter, returning the underlying writer.

This internal buffer is flushed before returning the writer. If the flush fails, then an error is returned.

Trait Implementations

impl<W: Debug> Debug for TabWriter<W>

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

Formats the value using the given formatter.

impl<W: Write> Write for TabWriter<W>

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.