Struct ANSIString 

pub struct ANSIString<T> { /* private fields */ }

A struct that owns T, also holds ANSI styles and colors

Implementations

impl<T> ANSIString<T>

pub fn clear(self) -> T

Returns ownership of T, while consuming self

pub fn to_string(self) -> String

where T: AsRef<str>,

to_string method implemented directly on struct for performance reasons

pub fn is_foreground_colored(&self) -> bool

Returns true if foreground (letters) of a string is colored

pub fn is_background_colored(&self) -> bool

Return true if background (bounding box) of a string is colored

pub fn is_colored(&self) -> bool

Returns true if both background and foreground of a string is colored

pub fn is_styled(&self) -> bool

Return true if string is styled, e.g. bold or italic

Trait Implementations

impl<T: Clone> Clone for ANSIString<T>

fn clone(&self) -> ANSIString<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Colored for &mut ANSIString<T>

type Output = ()

This is returned by all methods

fn blue(self) -> Self::Output

Colors foreground of a string in blue

fn on_blue(self) -> Self::Output

Colors background of a string in blue

fn cyan(self) -> Self::Output

Colors foreground of a string in cyan

fn on_cyan(self) -> Self::Output

Colors background of a string in cyan

fn green(self) -> Self::Output

Colors foreground of a string in green

fn on_green(self) -> Self::Output

Colors background of a string in green

fn magenta(self) -> Self::Output

Colors foreground of a string in magenta

fn on_magenta(self) -> Self::Output

Colors background of a string in magenta

fn orange(self) -> Self::Output

Colors foreground of a string in orange

fn on_orange(self) -> Self::Output

Colors background of a string in orange

fn red(self) -> Self::Output

Colors foreground of a string in red

fn on_red(self) -> Self::Output

Colors background of a string in red

fn yellow(self) -> Self::Output

Colors foreground of a string in yellow

fn on_yellow(self) -> Self::Output

Colors background of a string in yellow

fn rgb(self, r: u8, g: u8, b: u8) -> Self::Output

Colors foreground of a string in rgb

fn on_rgb(self, r: u8, g: u8, b: u8) -> Self::Output

Colors background of a string in rgb

impl<T> Colored for ANSIString<T>

type Output = ANSIString<T>

This is returned by all methods

fn blue(self) -> Self::Output

Colors foreground of a string in blue

fn on_blue(self) -> Self::Output

Colors background of a string in blue

fn cyan(self) -> Self::Output

Colors foreground of a string in cyan

fn on_cyan(self) -> Self::Output

Colors background of a string in cyan

fn green(self) -> Self::Output

Colors foreground of a string in green

fn on_green(self) -> Self::Output

Colors background of a string in green

fn magenta(self) -> Self::Output

Colors foreground of a string in magenta

fn on_magenta(self) -> Self::Output

Colors background of a string in magenta

fn orange(self) -> Self::Output

Colors foreground of a string in orange

fn on_orange(self) -> Self::Output

Colors background of a string in orange

fn red(self) -> Self::Output

Colors foreground of a string in red

fn on_red(self) -> Self::Output

Colors background of a string in red

fn yellow(self) -> Self::Output

Colors foreground of a string in yellow

fn on_yellow(self) -> Self::Output

Colors background of a string in yellow

fn rgb(self, r: u8, g: u8, b: u8) -> Self::Output

Colors foreground of a string in rgb

fn on_rgb(self, r: u8, g: u8, b: u8) -> Self::Output

Colors background of a string in rgb

impl<T: Debug> Debug for ANSIString<T>

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

Formats the value using the given formatter.

impl<T: AsRef<str>> Display for ANSIString<T>

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

Formats the value using the given formatter.

impl<T: AsRef<str>> From<ANSIString<T>> for String

fn from(value: ANSIString<T>) -> Self

Converts to this type from the input type.

impl<T: PartialEq> PartialEq for ANSIString<T>

fn eq(&self, other: &ANSIString<T>) -> 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<T> Styled for &mut ANSIString<T>

type Output = ()

This is returned by all methods

fn bold(self) -> Self::Output

Causes a string to be displayed as bold

fn dim(self) -> Self::Output

Causes a string to appear darker (not widely supported)

fn italic(self) -> Self::Output

Causes a string to be displayed as italic

fn underline(self) -> Self::Output

Causes a string to be displayed as underlined

fn blink(self) -> Self::Output

Causes a string to blink (not widely supported)

fn invert(self) -> Self::Output

Inverts colors of a string (not widely supported)

fn hide(self) -> Self::Output

Hides a string (not widely supported)

fn strikethrough(self) -> Self::Output

Causes a string to be displayed as striked out

impl<T> Styled for ANSIString<T>

type Output = ANSIString<T>

This is returned by all methods

fn bold(self) -> Self::Output

Causes a string to be displayed as bold

fn dim(self) -> Self::Output

Causes a string to appear darker (not widely supported)

fn italic(self) -> Self::Output

Causes a string to be displayed as italic

fn underline(self) -> Self::Output

Causes a string to be displayed as underlined

fn blink(self) -> Self::Output

Causes a string to blink (not widely supported)

fn invert(self) -> Self::Output

Inverts colors of a string (not widely supported)

fn hide(self) -> Self::Output

Hides a string (not widely supported)

fn strikethrough(self) -> Self::Output

Causes a string to be displayed as striked out

impl<T> StructuralPartialEq for ANSIString<T>