Struct termcolor::Buffer
[−]
[src]
pub struct Buffer(_);
Write colored text to memory.
Buffer
is a platform independent abstraction for printing colored text to
an in memory buffer. When the buffer is printed using a BufferWriter
, the
color information will be applied to the output device (a tty on Unix and a
console on Windows).
A Buffer
is typically created by calling the BufferWriter.buffer
method, which will take color preferences and the environment into
account. However, buffers can also be manually created using no_color
,
ansi
or console
(on Windows).
Methods
impl Buffer
[src]
fn no_color() -> Buffer
Create a buffer that drops all color information.
fn ansi() -> Buffer
Create a buffer that uses ANSI escape sequences.
fn is_empty(&self) -> bool
Returns true if and only if this buffer is empty.
fn len(&self) -> usize
Returns the length of this buffer in bytes.
fn clear(&mut self)
Clears this buffer.
fn into_inner(self) -> Vec<u8>
Consume this buffer and return the underlying raw data.
On Windows, this unrecoverably drops all color information associated with the buffer.
fn as_slice(&self) -> &[u8]
Return the underlying data of the buffer.
fn as_mut_slice(&mut self) -> &mut [u8]
Return the underlying data of the buffer as a mutable slice.
Trait Implementations
impl Write for Buffer
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0
Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0
Creates a "by reference" adaptor for this instance of Write
. Read more
impl WriteColor for Buffer
[src]
fn supports_color(&self) -> bool
Returns true if and only if the underlying writer supports colors.
fn set_color(&mut self, spec: &ColorSpec) -> Result<()>
Set the color settings of the writer. Read more
fn reset(&mut self) -> Result<()>
Reset the current color settings to their original settings. Read more