Enum ansitok::VisualAttribute

pub enum VisualAttribute {
    Bold,
    Faint,
    Italic,
    Underline,
    SlowBlink,
    RapidBlink,
    Inverse,
    Hide,
    Crossedout,
    Font(u8),
    Fraktur,
    DoubleUnderline,
    ProportionalSpacing,
    FgColor(AnsiColor),
    BgColor(AnsiColor),
    UndrColor(AnsiColor),
    Framed,
    Encircled,
    Overlined,
    IgrmUnderline,
    IgrmDoubleUnderline,
    IgrmOverline,
    IgrmdDoubleOverline,
    IgrmStressMarking,
    Superscript,
    Subscript,
    Reset(u8),
}

An attribute of Select Graphic Rendition(SGR)

Variants

Bold

A bold.

Faint

A faint.

Italic

An italic.

Underline

An underline.

SlowBlink

A slow blink.

RapidBlink

A rapid blink.

Inverse

Reverse video or invert.

Hide

Conceal or hide.

Crossedout

Crossed-out, or strike.

Font(u8)

A font.

A value is in range 10..=19

Fraktur

A fraktur (gothic)

DoubleUnderline

Doubly underlined; or: not bold.

ProportionalSpacing

A proportional spacing.

FgColor(AnsiColor)

A foreground color.

BgColor(AnsiColor)

A background color.

UndrColor(AnsiColor)

An underground color.

Framed

A framed.

Encircled

An encircled.

Overlined

An overlined.

IgrmUnderline

Ideogram underline or right side line.

IgrmDoubleUnderline

Ideogram double underline, or double line on the right side.

IgrmOverline

Ideogram overline or left side line.

IgrmdDoubleOverline

Ideogram double overline, or double line on the left side.

IgrmStressMarking

Ideogram stress marking.

Superscript

Superscript.

Subscript

Subscript.

Reset(u8)

Bold.

Implementations

impl VisualAttribute

pub fn parse<S>(text: S) -> Option<Self>where
    S: AsRef<str>,

Parse a visual attribute.

Example

use ansitok::VisualAttribute;

assert_eq!(VisualAttribute::parse("1"), Some(VisualAttribute::Bold));

Trait Implementations

impl Clone for VisualAttribute

fn clone(&self) -> VisualAttribute

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VisualAttribute

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

Formats the value using the given formatter.

impl Display for VisualAttribute

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

Formats the value using the given formatter.

impl Hash for VisualAttribute

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for VisualAttribute

fn cmp(&self, other: &VisualAttribute) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<VisualAttribute> for VisualAttribute

fn eq(&self, other: &VisualAttribute) -> bool

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

const 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.

impl PartialOrd<VisualAttribute> for VisualAttribute

fn partial_cmp(&self, other: &VisualAttribute) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for VisualAttribute

impl Eq for VisualAttribute

impl StructuralEq for VisualAttribute

impl StructuralPartialEq for VisualAttribute