Struct ANSIStr

pub struct ANSIStr<'a> { /* private fields */ }

The structure represents a ANSI color by suffix and prefix.

Implementations

impl<'a> ANSIStr<'a>

pub const fn new(prefix: &'a str, suffix: &'a str) -> ANSIStr<'a>

Constructs a new instance with suffix and prefix.

They are not checked so you should make sure you provide correct ANSI. Otherwise you may want to use TryFrom.

pub const fn empty() -> ANSIStr<'a>

Constructs a new instance with suffix and prefix set to empty strings.

pub const fn is_empty(&self) -> bool

Verifies if anything was actually set.

pub const fn get_prefix(&self) -> &'a str

Gets a reference to a prefix.

pub const fn get_suffix(&self) -> &'a str

Gets a reference to a suffix.

Trait Implementations

impl ANSIFmt for ANSIStr<'_>

fn fmt_ansi_prefix<W>(&self, f: &mut W) -> Result<(), Error>

where W: Write,

Print ANSI prefix.

fn fmt_ansi_suffix<W>(&self, f: &mut W) -> Result<(), Error>

where W: Write,

Print ANSI suffix.

impl<'a> Clone for ANSIStr<'a>

fn clone(&self) -> ANSIStr<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ANSIStr<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ANSIStr<'a>

fn default() -> ANSIStr<'a>

Returns the “default value” for a type.

impl From<ANSIStr<'_>> for ANSIBuf

fn from(value: ANSIStr<'_>) -> ANSIBuf

Converts to this type from the input type.

impl From<ANSIStr<'static>> for Color

fn from(color: StaticColor<'static>) -> Self

Converts to this type from the input type.

impl<'a> Hash for ANSIStr<'a>

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for ANSIStr<'a>

fn cmp(&self, other: &ANSIStr<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for ANSIStr<'a>

fn eq(&self, other: &ANSIStr<'a>) -> 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> PartialOrd for ANSIStr<'a>

fn partial_cmp(&self, other: &ANSIStr<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Copy for ANSIStr<'a>

impl<'a> Eq for ANSIStr<'a>

impl<'a> StructuralPartialEq for ANSIStr<'a>