Struct ansi_term::ANSIGenericString

pub struct ANSIGenericString<'a, S: 'a + ToOwned + ?Sized>where
    <S as ToOwned>::Owned: Debug,{ /* private fields */ }

An ANSIGenericString includes a generic string type and a Style to display that string. ANSIString and ANSIByteString are aliases for this type on str and \[u8], respectively.

Implementations

impl<'a, S: 'a + ToOwned + ?Sized> ANSIGenericString<'a, S>where
    <S as ToOwned>::Owned: Debug,

pub fn style_ref(&self) -> &Style

Directly access the style

pub fn style_ref_mut(&mut self) -> &mut Style

Directly access the style mutably

impl<'a> ANSIGenericString<'a, [u8]>

pub fn write_to<W: Write>(&self, w: &mut W) -> Result<()>

Write an ANSIByteString to an io::Write. This writes the escape sequences for the associated Style around the bytes.

Trait Implementations

impl<'a, S: 'a + ToOwned + ?Sized> Clone for ANSIGenericString<'a, S>where
    <S as ToOwned>::Owned: Debug,

Cloning an ANSIGenericString will clone its underlying string.

Examples

use ansi_term::ANSIString;

let plain_string = ANSIString::from("a plain string");
let clone_string = plain_string.clone();
assert_eq!(clone_string, plain_string);

fn clone(&self) -> ANSIGenericString<'a, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, S: Debug + 'a + ToOwned + ?Sized> Debug for ANSIGenericString<'a, S>where
    <S as ToOwned>::Owned: Debug,

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

Formats the value using the given formatter.

impl<'a, S: 'a + ToOwned + ?Sized> Deref for ANSIGenericString<'a, S>where
    <S as ToOwned>::Owned: Debug,

type Target = S

The resulting type after dereferencing.

fn deref(&self) -> &S

Dereferences the value.

impl<'a, I, S: 'a + ToOwned + ?Sized> From<I> for ANSIGenericString<'a, S>where
    I: Into<Cow<'a, S>>,
    <S as ToOwned>::Owned: Debug,

fn from(input: I) -> ANSIGenericString<'a, S>

Converts to this type from the input type.

impl<'a, S: PartialEq + 'a + ToOwned + ?Sized> PartialEq<ANSIGenericString<'a, S>> for ANSIGenericString<'a, S>where
    <S as ToOwned>::Owned: Debug,

fn eq(&self, other: &ANSIGenericString<'a, S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, S: 'a + ToOwned + ?Sized> StructuralPartialEq for ANSIGenericString<'a, S>where
    <S as ToOwned>::Owned: Debug,