Struct termcolor::StandardStream
source · [−]pub struct StandardStream { /* private fields */ }
Expand description
Satisfies io::Write
and WriteColor
, and supports optional coloring
to either of the standard output streams, stdout and stderr.
Implementations
sourceimpl StandardStream
impl StandardStream
sourcepub fn stdout(choice: ColorChoice) -> StandardStreamⓘNotable traits for StandardStreamimpl Write for StandardStream
pub fn stdout(choice: ColorChoice) -> StandardStreamⓘNotable traits for StandardStreamimpl Write for StandardStream
Create a new StandardStream
with the given color preferences that
writes to standard output.
On Windows, if coloring is desired and a Windows console could not be found, then ANSI escape sequences are used instead.
The specific color/style settings can be configured when writing via
the WriteColor
trait.
sourcepub fn stderr(choice: ColorChoice) -> StandardStreamⓘNotable traits for StandardStreamimpl Write for StandardStream
pub fn stderr(choice: ColorChoice) -> StandardStreamⓘNotable traits for StandardStreamimpl Write for StandardStream
Create a new StandardStream
with the given color preferences that
writes to standard error.
On Windows, if coloring is desired and a Windows console could not be found, then ANSI escape sequences are used instead.
The specific color/style settings can be configured when writing via
the WriteColor
trait.
sourcepub fn lock(&self) -> StandardStreamLock<'_>ⓘNotable traits for StandardStreamLock<'a>impl<'a> Write for StandardStreamLock<'a>
pub fn lock(&self) -> StandardStreamLock<'_>ⓘNotable traits for StandardStreamLock<'a>impl<'a> Write for StandardStreamLock<'a>
Lock the underlying writer.
The lock guard returned also satisfies io::Write
and
WriteColor
.
This method is not reentrant. It may panic if lock
is called
while a StandardStreamLock
is still alive.
Trait Implementations
sourceimpl Write for StandardStream
impl Write for StandardStream
sourcefn write(&mut self, b: &[u8]) -> Result<usize>
fn write(&mut self, b: &[u8]) -> Result<usize>
Write a buffer into this writer, returning how many bytes were written. Read more
sourcefn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
sourcefn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector
)Determines if this Write
r has an efficient write_vectored
implementation. Read more
1.0.0 · sourcefn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
Attempts to write an entire buffer into this writer. Read more
sourcefn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
write_all_vectored
)Attempts to write multiple buffers into this writer. Read more
sourceimpl WriteColor for StandardStream
impl WriteColor for StandardStream
sourcefn supports_color(&self) -> bool
fn supports_color(&self) -> bool
Returns true if and only if the underlying writer supports colors.
sourcefn set_color(&mut self, spec: &ColorSpec) -> Result<()>
fn set_color(&mut self, spec: &ColorSpec) -> Result<()>
Set the color settings of the writer. Read more
sourcefn reset(&mut self) -> Result<()>
fn reset(&mut self) -> Result<()>
Reset the current color settings to their original settings. Read more
sourcefn is_synchronous(&self) -> bool
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
. Read more
Auto Trait Implementations
impl RefUnwindSafe for StandardStream
impl Send for StandardStream
impl Sync for StandardStream
impl Unpin for StandardStream
impl UnwindSafe for StandardStream
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more