Enum Effect 

#[non_exhaustive]
pub enum Effect {
    Bold,
    Faint,
    Italic,
    Underline,
    Blink,
    Reverse,
    Hidden,
    Strike,
}

Represents the control sequences, named Select Graphic Rendition (SGR), that are used to enable various effects (e.g. italic) on ANSI terminals.

Effects can be combined arbitrarily.

Note: this enum is designed to be immutable and const

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Bold

Effect with SGR parameter 1

Faint

Effect with SGR parameter 2

Italic

Effect with SGR parameter 3

Underline

Effect with SGR parameter 4

Blink

Effect with SGR parameter 5

Reverse

Effect with SGR parameter 7

Hidden

Effect with SGR parameter 8

Strike

Effect with SGR parameter 9

Implementations

impl Effect

pub const fn all() -> &'static [Effect]

Get all Effects, which facilitates iterating.

pub const fn attr(&self) -> Attr<Effect>

Creates an Attr with this Effect

pub const fn not(&self) -> Ansi

Creates an Ansi style with the corresponding reset code for this Effect, as follows:

ANSI effect	SGR parameter
Bold	22
Faint	22
Italic	23
Underline	24
Blink	25
Reverse	27
Hidden	28
Strike	29

Note: Bold.not() and Faint.not() have the same parameter

pub const fn only(&self) -> Ansi

Creates an Ansi style with this Effect set to only.

pub const fn important(&self) -> Ansi

Creates an Ansi style with this Effect set to important.

pub const fn ansi(&self) -> Ansi

Used by the styled_*! macros to coerce a style argument to an Ansi instance.

Trait Implementations

impl Clone for Effect

fn clone(&self) -> Effect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Effect

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

Formats the value using the given formatter.

impl Display for Effect

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

Formats the value using the given formatter.

impl From<Effect> for Ansi

fn from(value: Effect) -> Ansi

Converts to this type from the input type.

impl PartialEq for Effect

fn eq(&self, other: &Effect) -> 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 Copy for Effect

impl Eq for Effect

impl StructuralPartialEq for Effect