Struct termcolor::Buffer

source ·
pub struct Buffer(pub(crate) BufferInner);
Expand description

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

Tuple Fields§

§0: BufferInner

Implementations§

source§

impl Buffer

source

pub(crate) fn new(choice: ColorChoice) -> Buffer

Create a new buffer with the given color settings.

source

pub fn no_color() -> Buffer

Create a buffer that drops all color information.

source

pub fn ansi() -> Buffer

Create a buffer that uses ANSI escape sequences.

source

pub fn is_empty(&self) -> bool

Returns true if and only if this buffer is empty.

source

pub fn len(&self) -> usize

Returns the length of this buffer in bytes.

source

pub fn clear(&mut self)

Clears this buffer.

source

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

source

pub fn as_slice(&self) -> &[u8]

Return the underlying data of the buffer.

source

pub fn as_mut_slice(&mut self) -> &mut [u8]

Return the underlying data of the buffer as a mutable slice.

Trait Implementations§

source§

impl Clone for Buffer

source§

fn clone(&self) -> Buffer

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Buffer

source§

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

Formats the value using the given formatter. Read more
source§

impl Write for Buffer

source§

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

Write a buffer into this writer, returning how many bytes were written. Read more
source§

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

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
1.36.0 · source§

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers. Read more
source§

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. Read more
1.0.0 · source§

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

Attempts to write an entire buffer into this writer. Read more
source§

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. Read more
1.0.0 · source§

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of Write. Read more
source§

impl WriteColor for Buffer

source§

fn supports_color(&self) -> bool

Returns true if and only if the underlying writer supports colors.
Returns true if and only if the underlying writer supports hyperlinks. Read more
source§

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

Set the color settings of the writer. Read more
Set the current hyperlink of the writer. Read more
source§

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

Reset the current color settings to their original settings. Read more
source§

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 Freeze for Buffer

§

impl RefUnwindSafe for Buffer

§

impl Send for Buffer

§

impl Sync for Buffer

§

impl Unpin for Buffer

§

impl UnwindSafe for Buffer

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.