Enum termcolor::WriterInnerLock

pub(crate) enum WriterInnerLock<'a, W> {
    NoColor(NoColor<W>),
    Ansi(Ansi<W>),
    Unreachable(PhantomData<&'a ()>),
}

WriterInnerLock is a (limited) generic representation of a writer. It is limited because W should only ever be stdout/stderr on Windows.

Variants

NoColor(NoColor<W>)

Ansi(Ansi<W>)

Unreachable(PhantomData<&'a ()>)

What a gross hack. On Windows, we need to specify a lifetime for the console when in a locked state, but obviously don’t need to do that on Unix, which makes the 'a unused. To satisfy the compiler, we need a PhantomData.

Trait Implementations

impl<'a, W: Debug> Debug for WriterInnerLock<'a, W>

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

Formats the value using the given formatter.

impl<'a, W: Write> Write for WriterInnerLock<'a, W>

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

Writes a buffer into this writer, returning how many bytes were written.

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

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(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

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 Self

where Self: Sized,

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

impl<'a, W: Write> WriteColor for WriterInnerLock<'a, W>

fn supports_color(&self) -> bool

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

fn supports_hyperlinks(&self) -> bool

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

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

Set the color settings of the writer.

fn set_hyperlink(&mut self, link: &HyperlinkSpec<'_>) -> Result<()>

Set the current hyperlink of the writer.

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

Reset the current color settings to their original settings.

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.