Struct anstyle_stream::Stream

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

std::io::Write that adapts ANSI escape codes to the underlying Writes capabilities

Implementations

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

pub fn always_ansi(write: W) -> Self

Force ANSI escape codes to be passed through as-is, no matter what the inner Write supports.

pub fn never(write: W) -> Self

Only pass printable data to the inner Write.

impl<W> Stream<W>where W: Lockable,

pub fn lock(&self) -> <Self as Lockable>::Locked

Get exclusive access to the Stream

Why?

• Faster performance when writing in a loop
• Avoid other threads interleaving output with the current thread

Trait Implementations

impl<W> Lockable for &Stream<W>where W: Lockable,

type Locked = Stream<<W as Lockable>::Locked>

fn lock(&self) -> Self::Locked

Get exclusive access to the Stream

impl<W> Lockable for Stream<W>where W: Lockable,

type Locked = Stream<<W as Lockable>::Locked>

fn lock(&self) -> Self::Locked

Get exclusive access to the Stream

impl<W> Write for Stream<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.

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

Attempts to write an entire buffer into this writer.

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_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 Selfwhere Self: Sized,

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