Struct Escaped 

pub struct Escaped<W: Write> { /* private fields */ }

A writer that shows control bytes as text — \x1b rather than a real ESC — so the terminal displays them instead of acting on them.

It sits between the printers and their termcolor::Buffer. trg’s own colours never pass through write: termcolor emits them from set_color and reset, which are delegated untouched, so they keep working while every byte that came out of a log or a member name is neutralised.

Escaped: C0 controls except tab and newline, DEL, and the UTF-8 encoded C1 controls U+0080..U+009F (U+009B is a CSI on terminals that honour C1). A carriage return is kept when it is half of a CRLF line ending — escaping it would litter every line of a Windows log — and escaped on its own, where it moves the cursor back over the line and can hide what came before it.

Both of the two-byte decisions (CR then LF, C2 then a C1 byte) can straddle two writes, so the first byte is held back until the next one arrives. A held byte survives a colour change — grep-printer resets colour between a match ending in CR and its LF — and is settled on flush and on drop.

Escaped::json renders the same bytes as JSON escapes (\u007f), because the JSON printer’s output is already-encoded JSON: serde escapes C0 itself but leaves DEL and C1 raw inside strings, and those are the only places such bytes can appear.

A literal \x1b already in a log prints the same as an escaped ESC. That ambiguity is accepted: backslashes are not escaped, so Windows paths and regexes in logs stay readable.

Implementations

impl<W: Write> Escaped<W>

pub fn new(inner: W, on: bool) -> Self

pub fn into_json(self) -> Self

Switch an unused writer to JSON escapes.

pub fn json(inner: W, on: bool) -> Self

Trait Implementations

impl<W: Write> Drop for Escaped<W>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<W: Write> Write for Escaped<W>

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

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

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

Flushes 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, args: 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.

impl<W: WriteColor> WriteColor for Escaped<W>

fn supports_color(&self) -> bool

Returns true if and only if the underlying writer supports colors.

fn set_color(&mut self, spec: &ColorSpec) -> Result<()>

Set the color settings of the writer.

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

Reset the current color settings to their original settings.

fn is_synchronous(&self) -> bool

Returns true if and only if the underlying writer must synchronously interact with an end user’s device in order to control colors. By default, this always returns false.

fn set_hyperlink(&mut self, link: &HyperlinkSpec<'_>) -> Result<()>

Set the current hyperlink of the writer.

fn supports_hyperlinks(&self) -> bool

Returns true if and only if the underlying writer supports hyperlinks.