Struct nu_ansi_term::AnsiGenericString

source ·
pub struct AnsiGenericString<'a, S: 'a + ToOwned + ?Sized>
where <S as ToOwned>::Owned: Debug,
{ /* private fields */ }
Expand description

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§

source§

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

source

pub const fn style_ref(&self) -> &Style

Directly access the style

source

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

Directly access the style mutably

source

pub fn as_str(&self) -> &S

Directly access the underlying string

source

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.

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.

source

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

Get any URL associated with the string

source§

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

source

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§

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

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

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.
source§

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

source§

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

Auto Trait Implementations§

§

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

§

impl<'a, S> RefUnwindSafe for AnsiGenericString<'a, S>

§

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

§

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

§

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

§

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

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.