Type Alias AnsiString

Source
pub type AnsiString<'a> = AnsiGenericString<'a, str>;
Expand description

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 nu_ansi_term::AnsiString;
use nu_ansi_term::Color::Red;

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

let plain_string = AnsiString::from("a plain string");

Aliased Type§

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

Implementations

Source§

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

Source

pub fn style_ref(&self) -> &Style

Directly access the style

Source

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

Directly access the style mutably

Trait Implementations§

Source§

impl<'a> Display for AnsiString<'a>

Source§

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

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

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 nu_ansi_term::AnsiString;

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

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

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<'a, S: Debug + 'a + ToOwned + ?Sized> Debug for AnsiGenericString<'a, S>
where <S as ToOwned>::Owned: Debug,

Source§

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

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

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

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

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 40 bytes