Enum Attribute

#[repr(u16)]
pub enum Attribute {
    Bold = 1,
    Dim = 2,
    Italic = 4,
    Underline = 8,
    Blink = 16,
    Blink2 = 32,
    Reverse = 64,
    Conceal = 128,
    Strike = 256,
    Underline2 = 512,
    Frame = 1_024,
    Encircle = 2_048,
    Overline = 4_096,
}

Individual effects that can be applied to text in a terminal.

Attribute values can be combined with bitwise operators to produce AttributeSets.

Attribute values can be parsed from the following case-insensitive strings:

• "bold" or "b" — Bold
• "dim" or "d" — Dim
• "italic" or "i" — Italic
• "underline" or "u" — Underline
• "blink" — Blink
• "blink2" — Blink2
• "reverse" or "r" — Reverse
• "conceal" or "c" — Conceal
• "strike" or "s" — Strike
• "underline2" or "uu" — Underline2
• "frame" — Frame
• "encircle" — Encircle
• "overline" — Overline

Attribute values are displayed as lowercase strings from the above list; for values with two strings, the longer one is used.

Variants

Bold = 1

Dim = 2

Italic = 4

Underline = 8

Blink = 16

Blink2 = 32

Fast blinking

Reverse = 64

Reverse video

Conceal = 128

Concealed/hidden

Strike = 256

Strikethrough

Underline2 = 512

Double-underline

Frame = 1_024

Encircle = 2_048

Overline = 4_096

Implementations

impl Attribute

pub fn iter() -> AttributeIter

Returns an iterator over all Attribute variants

pub fn as_str(self) -> &'static str

Return the long name of the attribute

Example

use parse_style::Attribute;

assert_eq!(Attribute::Bold.as_str(), "bold");

Trait Implementations

impl<A: Into<AttributeSet>> BitAnd<A> for Attribute

type Output = AttributeSet

The resulting type after applying the & operator.

fn bitand(self, rhs: A) -> AttributeSet

Performs the & operation.

impl<A: Into<AttributeSet>> BitOr<A> for Attribute

type Output = AttributeSet

The resulting type after applying the | operator.

fn bitor(self, rhs: A) -> AttributeSet

Performs the | operation.

impl<A: Into<AttributeSet>> BitXor<A> for Attribute

type Output = AttributeSet

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: A) -> AttributeSet

Performs the ^ operation.

impl Clone for Attribute

fn clone(&self) -> Attribute

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Attribute

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

Formats the value using the given formatter.

impl Display for Attribute

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

Formats the value using the given formatter.

impl Extend<Attribute> for AttributeSet

fn extend<I: IntoIterator<Item = Attribute>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Attribute> for AttributeSet

fn from(value: Attribute) -> AttributeSet

Converts to this type from the input type.

impl From<Attribute> for Style

fn from(value: Attribute) -> Style

Construct a new Style that enables the given attribute

impl FromIterator<Attribute> for AttributeSet

fn from_iter<I: IntoIterator<Item = Attribute>>(iter: I) -> Self

Creates a value from an iterator.

impl FromStr for Attribute

type Err = ParseAttributeError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Attribute, ParseAttributeError>

Parses a string s to return a value of this type.

impl Hash for Attribute

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoEnumIterator for Attribute

type Iterator = AttributeIter

fn iter() -> AttributeIter

impl Not for Attribute

type Output = AttributeSet

The resulting type after applying the ! operator.

fn not(self) -> AttributeSet

Performs the unary ! operation.

impl Ord for Attribute

fn cmp(&self, other: &Attribute) -> 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 PartialEq for Attribute

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

Tests for self and other values to be equal, and is used by ==.

const 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 PartialOrd for Attribute

fn partial_cmp(&self, other: &Attribute) -> 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: Into<AttributeSet>> Sub<A> for Attribute

type Output = AttributeSet

The resulting type after applying the - operator.

fn sub(self, rhs: A) -> AttributeSet

Performs the - operation.

impl Copy for Attribute

impl Eq for Attribute

impl StructuralPartialEq for Attribute