Struct strip_ansi_escapes::Writer

pub struct Writer<W> where
    W: Write,  { /* fields omitted */ }

Writer wraps an underlying type that implements Write, stripping ANSI escape sequences from bytes written to it before passing them to the underlying writer.

Example

use std::io::{self, Write};
use strip_ansi_escapes::Writer;

let bytes_with_colors = b"\x1b[32mfoo\x1b[m bar";
let mut writer = Writer::new(io::stdout());
// Only `foo bar` will be written to stdout
writer.write_all(bytes_with_colors)?;

Implementations

impl<W> Writer<W> where
    W: Write, 

pub fn new(inner: W) -> Writer<W>

Create a new Writer that writes to inner.

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

Unwraps this Writer, returning the underlying writer.

The internal buffer is written out before returning the writer, which may produce an IntoInnerError.

Trait Implementations

impl<W> Write for Writer<W> where
    W: Write, 

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.

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

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

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

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

Attempts to write an entire buffer into this writer.

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

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

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

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

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