pub type Stdout = AutoStream<Stdout>;
Expand description
An adaptive wrapper around the global standard output stream of the current process
Aliased Type§
struct Stdout {
inner: StreamInner<Stdout>,
}
Fields§
§inner: StreamInner<Stdout>
Implementations
Source§impl<S> AutoStream<S>where
S: RawStream,
impl<S> AutoStream<S>where
S: RawStream,
Sourcepub fn new(raw: S, choice: ColorChoice) -> Self
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);
Sourcepub fn choice(raw: &S) -> ColorChoice
pub fn choice(raw: &S) -> ColorChoice
Report the desired choice for the given stream
Sourcepub fn always_ansi(raw: S) -> Self
pub fn always_ansi(raw: S) -> Self
Force ANSI escape codes to be passed through as-is, no matter what the inner Write
supports.
fn always_ansi_(raw: S) -> Self
fn wincon(raw: S) -> Result<Self, S>
Sourcepub fn into_inner(self) -> S
pub fn into_inner(self) -> S
Get the wrapped RawStream
Sourcepub fn is_terminal(&self) -> bool
pub fn is_terminal(&self) -> bool
Returns true
if the descriptor/handle refers to a terminal/tty.
Sourcepub fn current_choice(&self) -> ColorChoice
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>
impl AutoStream<Stdout>
Sourcepub fn lock(self) -> AutoStream<StdoutLock<'static>> ⓘ
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
Trait Implementations
Source§impl<S> Write for AutoStream<S>where
S: RawStream + AsLockedWrite,
impl<S> Write for AutoStream<S>where
S: RawStream + AsLockedWrite,
Source§fn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
Writes a buffer into this writer, returning how many bytes were written. Read more
Source§fn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
Flushes this output stream, ensuring that all intermediately buffered
contents reach their destination. Read more
Source§fn write_all(&mut self, buf: &[u8]) -> Result<()>
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<()>
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
fn is_write_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector
)