Struct 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 const fn style_ref(&self) -> &Style

Directly access the style

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

Directly access the style mutably

pub fn as_str(&self) -> &S

Directly access the underlying string

pub fn title<I>(s: I) -> Self

where I: Into<Cow<'a, S>>,

Produce an ANSI string that changes the title shown by the terminal emulator.

Examples

use nu_ansi_term::AnsiGenericString;
let title_string = AnsiGenericString::title("My Title");
println!("{}", title_string);

Should produce an empty line but set the terminal title.

pub fn hyperlink<I>(self, url: I) -> Self

where I: Into<Cow<'a, S>>,

Cause the styled ANSI string to link to the given URL

Examples

use nu_ansi_term::Color::Red;

let link_string = Red.paint("a red string").hyperlink("https://www.example.com");
println!("{}", link_string);

Should show a red-painted string which, on terminals that support it, is a clickable hyperlink.

pub fn url_string(&self) -> Option<&S>

Get any URL associated with the string

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 nu_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, 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: Eq + 'a + ToOwned + ?Sized> Eq for AnsiGenericString<'a, S>

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

impl<'a, S: 'a + ToOwned + ?Sized> StructuralPartialEq for AnsiGenericString<'a, S>

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