Struct TermString 

#[repr(transparent)]
pub struct TermString(pub String);

A String wrapper that implements both io::Write and WriteColor.

This type provides backward compatibility with libraries like naga that expect string-like writers to implement WriteColor. It’s a zero-cost wrapper around String that adds the necessary trait implementations.

Tuple Fields

0: String

Implementations

impl TermString

pub fn new() -> Self

Creates a new empty TermString.

pub fn with_capacity(capacity: usize) -> Self

Creates a new TermString with the specified capacity.

pub fn into_inner(self) -> String

Consumes the TermString and returns the inner String.

pub fn as_str(&self) -> &str

Returns a string slice of the TermString contents.

pub fn push_str(&mut self, s: &str)

Appends a string slice to the end of this TermString.

Trait Implementations

impl AsRef<str> for TermString

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for TermString

fn clone(&self) -> TermString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TermString

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

Formats the value using the given formatter.

impl Default for TermString

fn default() -> TermString

Returns the “default value” for a type.

impl Display for TermString

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

Formats the value using the given formatter.

impl From<String> for TermString

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<TermString> for String

fn from(ts: TermString) -> Self

Converts to this type from the input type.

impl Hash for TermString

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TermString

fn cmp(&self, other: &TermString) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TermString

fn eq(&self, other: &TermString) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TermString

fn partial_cmp(&self, other: &TermString) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Write for TermString

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, args: 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 WriteColor for TermString

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.

impl Eq for TermString

impl StructuralPartialEq for TermString