Type Alias ANSIString

pub type ANSIString<'a> = ANSIGenericString<'a, str>;

An ANSI String is a string coupled with the Style to display it in a terminal.

Although not technically a string itself, it can be turned into one with the to_string method.

Examples

use ansi_term::ANSIString;
use ansi_term::Colour::Red;

let red_string = Red.paint("a red string");
println!("{}", red_string);

use ansi_term::ANSIString;

let plain_string = ANSIString::from("a plain string");
assert_eq!(&*plain_string, "a plain string");

Aliased Type

struct ANSIString<'a> { /* private fields */ }

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

Trait Implementations

impl<'a> Display for ANSIString<'a>

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

Formats the value using the given formatter.

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.

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 for ANSIGenericString<'a, S>

where <S as ToOwned>::Owned: Debug,

fn eq(&self, other: &ANSIGenericString<'a, S>) -> 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<'a, S: 'a + ToOwned + ?Sized> StructuralPartialEq for ANSIGenericString<'a, S>

where <S as ToOwned>::Owned: Debug,