Struct anstyle::XTermColor

#[repr(transparent)]
pub struct XTermColor(pub u8);

Index into the 8-bit ANSI color palette

Tuple Fields

0: u8

Implementations

impl XTermColor

pub fn index(self) -> u8

pub fn render_fg(self) -> impl Display

Render the ANSI code for a foreground color

pub fn render_bg(self) -> impl Display

Render the ANSI code for a background color

Trait Implementations

impl<C: Into<Color>> BitOr<C> for XTermColor

Define style with specified foreground and background colors

Examples

let black = anstyle::XTermColor(16);
let white = anstyle::XTermColor(231);
let style = black | white;

type Output = Style

The resulting type after applying the | operator.

fn bitor(self, rhs: C) -> Self::Output

Performs the | operation.

impl BitOr<Effects> for XTermColor

Define style with specified foreground color and effects

Examples

let color = anstyle::XTermColor(0);
let style = color | anstyle::Effects::BOLD | anstyle::Effects::UNDERLINE;

type Output = Style

The resulting type after applying the | operator.

fn bitor(self, rhs: Effects) -> Self::Output

Performs the | operation.

impl Clone for XTermColor

fn clone(&self) -> XTermColor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for XTermColor

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

Formats the value using the given formatter.

impl From<XTermColor> for Color

fn from(inner: XTermColor) -> Self

Converts to this type from the input type.

impl From<XTermColor> for Style

Define style with specified foreground color

Examples

let style: anstyle::Style = anstyle::XTermColor(0).into();

fn from(color: XTermColor) -> Self

Converts to this type from the input type.

impl From<u8> for XTermColor

fn from(inner: u8) -> Self

Converts to this type from the input type.

impl Hash for XTermColor

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 XTermColor

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<XTermColor> for XTermColor

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

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

fn ne(&self, other: &XTermColor) -> bool

This method tests for !=.

impl PartialOrd<XTermColor> for XTermColor

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

impl Eq for XTermColor

impl StructuralEq for XTermColor

impl StructuralPartialEq for XTermColor