Struct anstream::AutoStream

pub struct AutoStream<S: RawStream> { /* private fields */ }

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

Implementations

impl<S> AutoStream<S>where
    S: RawStream,

pub fn new(raw: S, choice: ColorChoice) -> Self

Runtime control over styling behavior

pub fn auto(raw: S) -> Self

Auto-adapt for the stream’s capabilities

pub fn choice(raw: &S) -> ColorChoice

Report the desired choice for the given stream

pub fn always_ansi(raw: S) -> Self

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

pub fn always(raw: S) -> Self

Force color, no matter what the inner Write supports.

pub fn never(raw: S) -> Self

Only pass printable data to the inner Write.

pub fn into_inner(self) -> S

Get the wrapped RawStream

pub fn is_terminal(&self) -> bool

impl<S> AutoStream<S>where
    S: Lockable + RawStream,
    <S as Lockable>::Locked: RawStream,

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

Get exclusive access to the AutoStream

Why?

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

Trait Implementations

impl<S: Debug + RawStream> Debug for AutoStream<S>

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

Formats the value using the given formatter.

impl<S> IsTerminal for AutoStream<S>where
    S: RawStream,

fn is_terminal(&self) -> bool

Returns true if this is a terminal.

impl<S> Lockable for AutoStream<S>where
    S: Lockable + RawStream,
    <S as Lockable>::Locked: RawStream,

type Locked = AutoStream<<S as Lockable>::Locked>

fn lock(self) -> Self::Locked

Get exclusive access to the AutoStream

impl<S> Write for AutoStream<S>where
    S: RawStream,

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.