Enum makeup::SgrParameter

pub enum SgrParameter {
    Reset,
    Bold,
    Faint,
    Italic,
    Underline,
    Blink,
    RapidBlink,
    ReverseVideo,
    Conceal,
    CrossedOut,
    PrimaryFont,
    AlternativeFont(u64),
    Fraktur,
    DoubleUnderline,
    NormalIntensity,
    NotItalicOrBlackletter,
    NotUnderlined,
    SteadyCursor,
    ProportionalSpacing,
    NotReversed,
    Reveal,
    NotCrossedOut,
    ForegroundColour(Colour),
    BackgroundColour(Colour),
    HexForegroundColour(u32),
    HexBackgroundColour(u32),
    DefaultForegroundColour,
    DefaultBackgroundColour,
    DisableProportionalSpacing,
    Framed,
    Encircled,
    Overlined,
    NotFramedOrEncircled,
    NotOverlined,
    UnderlineColour(Colour),
    HexUnderlineColour(u32),
    DefaultUnderlineColour,
    IdeogramUnderlineOrRightSideLine,
    IdeogramDoubleUnderlineOrDoubleLineOnTheRightSide,
    IdeogramOverlineOrLeftSideLine,
    IdeogramDoubleOverlineOrDoubleLineOnTheLeftSide,
    IdeogramStressMarking,
    IdeogramAttributesOff,
    Superscript,
    Subscript,
    NotSuperscriptOrSubscript,
}

See: https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters

Variants

Reset

Reset all attributes.

Bold

Bold.

Faint

Faint.

Italic

Italic.

Underline

Underline.

Blink

Blink.

RapidBlink

Rapid blink.

ReverseVideo

Reverse video (note: Wikipedia notes inconsistent behaviour). Also known as “invert.”

Conceal

Conceal / hide text (note: Wikipedia notes lack of wide support).

CrossedOut

Crossed out. Not supported in Terminal.app.

PrimaryFont

Select the primary font.

AlternativeFont(u64)

Select the alternative font at the given index (N-10).

Fraktur

Fraktur/Gothic mode (note: Wikipedia notes lack of wide support).

DoubleUnderline

Double underline. Note: On some systems, this may instead disable Bold.

NormalIntensity

Normal intensity.

NotItalicOrBlackletter

Not italic or blackletter.

NotUnderlined

Not underlined.

SteadyCursor

Steady cursor (not blinking).

ProportionalSpacing

Proportional spacing. Note: Wikipedia says:

ITU T.61 and T.416, not known to be used on terminals.

NotReversed

Not reversed. Presumably undoes ReverseVideo, needs testing.

Reveal

Reveal concealed text. Presumably undoes Conceal, needs testing.

NotCrossedOut

Not crossed out.

ForegroundColour(Colour)

Set foreground colour to the given colour.

BackgroundColour(Colour)

Set background colour to the given colour.

HexForegroundColour(u32)

Set the foreground colour to the given hex colour.

HexBackgroundColour(u32)

Set the background colour to the given hex colour.

DefaultForegroundColour

Presumably resets to the default foreground colour, needs testing.

DefaultBackgroundColour

Presumably resets to the default background colour, needs testing.

DisableProportionalSpacing

Disable proportional spacing.

Framed

Set the framing (encircled) attribute.

Encircled

Set the encircled attribute.

Overlined

Set the overlined attribute. Note: Not supported in Terminal.app. Note: On some systems, this may instead enable Bold.

NotFramedOrEncircled

Not framed or encircled.

NotOverlined

Not overlined.

UnderlineColour(Colour)

Set the underline colour. Note: Not in standard, implemented in Kitty, VTE, mintty, iTerm2.

HexUnderlineColour(u32)

Set the underline colour to the given hex colour. Note: Not in standard, implemented in Kitty, VTE, mintty, iTerm2.

DefaultUnderlineColour

Set the underline colour to the default. Note: Not in standard, implemented in Kitty, VTE, mintty, iTerm2.

IdeogramUnderlineOrRightSideLine

Ideogram underline or right side line.

IdeogramDoubleUnderlineOrDoubleLineOnTheRightSide

Ideogram double underline or double line on the right side.

IdeogramOverlineOrLeftSideLine

Ideogram overline or left side line.

IdeogramDoubleOverlineOrDoubleLineOnTheLeftSide

Ideogram double overline or double line on the left side.

IdeogramStressMarking

Ideogram stress marking.

IdeogramAttributesOff

Ideogram attributes off. Resets:

• IdeogramUnderlineOrRightSideLine
• IdeogramDoubleUnderlineOrDoubleLineOnTheRightSide
• IdeogramOverlineOrLeftSideLine
• IdeogramDoubleOverlineOrDoubleLineOnTheLeftSide
• IdeogramStressMarking.

Superscript

Implemented only in mintty.

Subscript

Implemented only in mintty.

NotSuperscriptOrSubscript

Implemented only in mintty.

Trait Implementations

impl Clone for SgrParameter

fn clone(&self) -> SgrParameter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SgrParameter

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

Formats the value using the given formatter.

impl Hash for SgrParameter

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 Ord for SgrParameter

fn cmp(&self, other: &SgrParameter) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for SgrParameter

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

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

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 for SgrParameter

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

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

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

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

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

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

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

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

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 Eq for SgrParameter

impl StructuralEq for SgrParameter

impl StructuralPartialEq for SgrParameter