BasicColor

Enum BasicColor 

Source
pub enum BasicColor {
    Black,
    Red,
    Green,
    Yellow,
    Blue,
    Magenta,
    Cyan,
    White,
}
Expand description

The 8 basic non-bright terminal colors.

These colors are also available as associated constants in the Color enum:

use fluent_ansi::{prelude::*, color::BasicColor};

assert_eq!(Color::RED, BasicColor::Red);
assert_eq!(Color::GREEN, BasicColor::Green);
assert_eq!(Color::BLUE, BasicColor::Blue);
// etc.

See Wikipedia’s article on 3-bit and 4-bit colors ANSI escape codes.

Variants§

§

Black

The black color.

§

Red

The red color.

§

Green

The green color.

§

Yellow

The yellow color.

§

Blue

The blue color.

§

Magenta

The magenta color.

§

Cyan

The cyan color.

§

White

The white color.

Implementations§

Source§

impl BasicColor

Source

pub fn bright(self) -> SimpleColor

Returns a bright variant of this basic color.

Source§

impl BasicColor

Source

pub fn for_fg(self) -> TargetedColor

Associate this color with the foreground plane.

Source

pub fn for_bg(self) -> TargetedColor

Associate this color with the background plane.

Source

pub fn for_underline(self) -> TargetedColor

Associate this color with the underline effect.

Source

pub fn for_target(self, target: ColorTarget) -> TargetedColor

Associate this color with the specified color target.

Source§

impl BasicColor

Source

pub fn bold(self) -> Style

Sets the bold effect.

Source

pub fn faint(self) -> Style

Sets the faint effect.

Source

pub fn italic(self) -> Style

Sets the italic effect.

Source

pub fn underline(self) -> Style

Source

pub fn solid_underline(self) -> Style

Sets the solid underline effect.

Source

pub fn curly_underline(self) -> Style

Sets the curly underline effect.

Source

pub fn dotted_underline(self) -> Style

Sets the dotted underline effect.

Source

pub fn dashed_underline(self) -> Style

Sets the dashed underline effect.

Sets the blink effect.

Source

pub fn reverse(self) -> Style

Sets the reverse effect.

Source

pub fn conceal(self) -> Style

Sets the conceal effect.

Source

pub fn strikethrough(self) -> Style

Sets the strikethrough effect.

Source

pub fn double_underline(self) -> Style

Sets the double underline effect.

Source

pub fn overline(self) -> Style

Sets the overline effect.

Source

pub fn effect(self, effect: impl Into<Effect>) -> Style

Sets the given effect.

Source

pub fn underline_effect(self, underline_effect: UnderlineEffect) -> Style

Sets the underline effect.

Source

pub fn fg(self, color: impl Into<Color>) -> Style

Sets the foreground color.

Source

pub fn bg(self, color: impl Into<Color>) -> Style

Sets the background color.

Source

pub fn underline_color(self, color: impl Into<Color>) -> Style

Sets the underline color.

Source

pub fn color(self, targeted_color: impl Into<TargetedColor>) -> Style

Sets the given color in a target.

Source

pub fn add(self, element: impl StylingElement<Style>) -> Style

Adds the given element to the style.

Source

pub fn applied_to<C: Display>(self, content: C) -> Styled<C>

Applies the styling to the given content, returning a Styled<C> instance.

Source§

impl BasicColor

Source

pub fn to_style(self) -> Style

Converts the type into a Style.

Source§

impl BasicColor

Source

pub fn to_color(self) -> Color

Convert this type into a Color.

Source§

impl BasicColor

Source

pub fn to_targeted_color(self) -> TargetedColor

Converts the type into a TargetedColor

Source§

impl BasicColor

Source

pub fn to_simple_color(self) -> SimpleColor

Convert this basic color into a SimpleColor.

Trait Implementations§

Source§

impl Clone for BasicColor

Source§

fn clone(&self) -> BasicColor

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BasicColor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<BasicColor> for Color

Source§

fn from(value: BasicColor) -> Self

Converts to this type from the input type.
Source§

impl From<BasicColor> for SimpleColor

Source§

fn from(value: BasicColor) -> Self

Converts to this type from the input type.
Source§

impl From<BasicColor> for Style

Source§

fn from(value: BasicColor) -> Self

Converts to this type from the input type.
Source§

impl From<BasicColor> for TargetedColor

Source§

fn from(value: BasicColor) -> Self

Converts to this type from the input type.
Source§

impl Hash for BasicColor

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq<BasicColor> for Color

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<BasicColor> for SimpleColor

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<Color> for BasicColor

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<SimpleColor> for BasicColor

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq for BasicColor

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StylingElement<Style> for BasicColor

Source§

fn add_to(self, composed_styling: Style) -> Style

Adds this element to the given parameter, returning it updated.
Source§

impl<C: Display> StylingElement<Styled<C>> for BasicColor

Source§

fn add_to(self, composed_styling: Styled<C>) -> Styled<C>

Adds this element to the given parameter, returning it updated.
Source§

impl Copy for BasicColor

Source§

impl Eq for BasicColor

Source§

impl StructuralPartialEq for BasicColor

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.