Trait termcolor::WriteColor

pub trait WriteColor: Write {
    pub fn supports_color(&self) -> bool;
    pub fn set_color(&mut self, spec: &ColorSpec) -> Result<()>;
    pub fn reset(&mut self) -> Result<()>;

    pub fn is_synchronous(&self) -> bool { ... }
}

This trait describes the behavior of writers that support colored output.

Required methods

pub fn supports_color(&self) -> bool

Returns true if and only if the underlying writer supports colors.

pub fn set_color(&mut self, spec: &ColorSpec) -> Result<()>

Set the color settings of the writer.

Subsequent writes to this writer will use these settings until either reset is called or new color settings are set.

If there was a problem setting the color settings, then an error is returned.

pub fn reset(&mut self) -> Result<()>

Reset the current color settings to their original settings.

If there was a problem resetting the color settings, then an error is returned.

Loading content...

Provided methods

pub 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.

In practice, this should return true if the underlying writer is manipulating colors using the Windows console APIs.

This is useful for writing generic code (such as a buffered writer) that can perform certain optimizations when the underlying writer doesn't rely on synchronous APIs. For example, ANSI escape sequences can be passed through to the end user's device as is.

Loading content...

Implementations on Foreign Types

impl<'a, T: ?Sized + WriteColor> WriteColor for &'a mut T

pub fn supports_color(&self) -> bool

pub fn set_color(&mut self, spec: &ColorSpec) -> Result<()>

pub fn reset(&mut self) -> Result<()>

pub fn is_synchronous(&self) -> bool

impl<T: ?Sized + WriteColor> WriteColor for Box<T>

pub fn supports_color(&self) -> bool

pub fn set_color(&mut self, spec: &ColorSpec) -> Result<()>

pub fn reset(&mut self) -> Result<()>

pub fn is_synchronous(&self) -> bool

Loading content...

Implementors

impl WriteColor for Buffer

pub fn supports_color(&self) -> bool

pub fn set_color(&mut self, spec: &ColorSpec) -> Result<()>

pub fn reset(&mut self) -> Result<()>

pub fn is_synchronous(&self) -> bool

impl WriteColor for BufferedStandardStream

pub fn supports_color(&self) -> bool

pub fn set_color(&mut self, spec: &ColorSpec) -> Result<()>

pub fn reset(&mut self) -> Result<()>

pub fn is_synchronous(&self) -> bool

impl WriteColor for StandardStream

pub fn supports_color(&self) -> bool

pub fn set_color(&mut self, spec: &ColorSpec) -> Result<()>

pub fn reset(&mut self) -> Result<()>

pub fn is_synchronous(&self) -> bool

impl<'a> WriteColor for StandardStreamLock<'a>

pub fn supports_color(&self) -> bool

pub fn set_color(&mut self, spec: &ColorSpec) -> Result<()>

pub fn reset(&mut self) -> Result<()>

pub fn is_synchronous(&self) -> bool

impl<W: Write> WriteColor for Ansi<W>

pub fn supports_color(&self) -> bool

pub fn set_color(&mut self, spec: &ColorSpec) -> Result<()>

pub fn reset(&mut self) -> Result<()>

pub fn is_synchronous(&self) -> bool

impl<W: Write> WriteColor for NoColor<W>

pub fn supports_color(&self) -> bool

pub fn set_color(&mut self, _: &ColorSpec) -> Result<()>

pub fn reset(&mut self) -> Result<()>

pub fn is_synchronous(&self) -> bool

Loading content...