Struct anstream::AutoStream

source ·
pub struct AutoStream<S: RawStream> { /* private fields */ }
Expand description

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

This includes

You can customize auto-detection by calling into anstyle_query to get a ColorChoice and then calling [AutoStream::new(stream, choice)].

Implementations§

source§

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

source

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

Runtime control over styling behavior

§Example
// Like `AutoStream::choice` but without `NO_COLOR`, `CLICOLOR_FORCE`, `CI`
fn choice(raw: &dyn anstream::stream::RawStream) -> anstream::ColorChoice {
    let choice = anstream::ColorChoice::global();
    if choice == anstream::ColorChoice::Auto {
        if raw.is_terminal() && anstyle_query::term_supports_color() {
            anstream::ColorChoice::Always
        } else {
            anstream::ColorChoice::Never
        }
    } else {
        choice
    }
}

let stream = std::io::stdout();
let choice = choice(&stream);
let auto = anstream::AutoStream::new(stream, choice);
source

pub fn auto(raw: S) -> Self

Auto-adapt for the stream’s capabilities

source

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

Report the desired choice for the given stream

source

pub fn always_ansi(raw: S) -> Self

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

source

pub fn always(raw: S) -> Self

Force color, no matter what the inner Write supports.

source

pub fn never(raw: S) -> Self

Only pass printable data to the inner Write.

source

pub fn into_inner(self) -> S

Get the wrapped RawStream

source

pub fn is_terminal(&self) -> bool

Returns true if the descriptor/handle refers to a terminal/tty.

source

pub fn current_choice(&self) -> ColorChoice

Prefer AutoStream::choice

This doesn’t report what is requested but what is currently active.

source§

impl AutoStream<Stdout>

source

pub fn lock(self) -> AutoStream<StdoutLock<'static>>

Get exclusive access to the AutoStream

Why?

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

impl AutoStream<Stderr>

source

pub fn lock(self) -> AutoStream<StderrLock<'static>>

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§

source§

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

source§

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

Formats the value using the given formatter. Read more
source§

impl<S> Write for AutoStream<S>

source§

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

Write a buffer into this writer, returning how many bytes were written. Read more
source§

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

Like write, except that it writes from a slice of buffers. Read more
source§

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

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
source§

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

Attempts to write an entire buffer into this writer. Read more
source§

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

Writes a formatted string into this writer, returning any error encountered. Read more
source§

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. Read more
source§

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. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

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

Auto Trait Implementations§

§

impl<S> Freeze for AutoStream<S>
where S: Freeze,

§

impl<S> RefUnwindSafe for AutoStream<S>
where S: RefUnwindSafe,

§

impl<S> Send for AutoStream<S>
where S: Send,

§

impl<S> Sync for AutoStream<S>
where S: Sync,

§

impl<S> Unpin for AutoStream<S>
where S: Unpin,

§

impl<S> UnwindSafe for AutoStream<S>
where S: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.