Enum Color

Source
pub enum Color {
    TerminalDefault,
    Dark(BaseColor),
    Light(BaseColor),
    Rgb(u8, u8, u8),
    RgbLowRes(u8, u8, u8),
}
Expand description

Represents a color used by the theme.

Variants§

§

TerminalDefault

Represents a color, preset by terminal.

§

Dark(BaseColor)

One of the 8 base colors.

These colors should work on any terminal.

Note: the actual color used depends on the terminal configuration.

§

Light(BaseColor)

Lighter version of a base color.

The native linux TTY usually doesn’t support these colors, but almost all terminal emulators should.

Note: the actual color used depends on the terminal configuration.

§

Rgb(u8, u8, u8)

True-color, 24-bit.

On terminals that don’t support this, the color will be “downgraded” to the closest one available.

§

RgbLowRes(u8, u8, u8)

Low-resolution color.

Each value should be <= 5 (you’ll get panics otherwise).

These 216 possible colors are part of the terminal color palette (256 colors).

Implementations§

Source§

impl Color

Source

pub const fn from_256colors(n: u8) -> Color

Creates a color from its ID in the 256 colors list.

  • Colors 0-7 are base dark colors.
  • Colors 8-15 are base light colors.
  • Colors 16-231 are rgb colors with 6 values per channel (216 colors).
  • Colors 232-255 are grayscale colors.
Source

pub const fn low_res(r: u8, g: u8, b: u8) -> Option<Color>

Creates a Color::RgbLowRes from the given values for red, green and blue.

Returns None if any of the values exceeds 5.

Source

pub fn parse(value: &str) -> Option<Color>

Parse a string into a color.

Examples:

  • "red" becomes Color::Dark(BaseColor::Red)
  • "light green" becomes Color::Light(BaseColor::Green)
  • "default" becomes Color::TerminalDefault
  • "#123456" becomes Color::Rgb(0x12, 0x34, 0x56)

Trait Implementations§

Source§

impl Clone for Color

Source§

fn clone(&self) -> Color

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 Color

Source§

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

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

impl Default for Color

Source§

fn default() -> Color

Returns the “default value” for a type. Read more
Source§

impl From<Color> for ColorStyle

Source§

fn from(color: Color) -> ColorStyle

Converts to this type from the input type.
Source§

impl From<Color> for ColorType

Source§

fn from(color: Color) -> ColorType

Converts to this type from the input type.
Source§

impl From<Color> for Style

Source§

fn from(color: Color) -> Style

Converts to this type from the input type.
Source§

impl From<Color> for StyleType

Source§

fn from(color: Color) -> StyleType

Converts to this type from the input type.
Source§

impl From<Rgb> for Color

Source§

fn from(rgb: Rgb) -> Color

Converts to this type from the input type.
Source§

impl FromStr for Color

Source§

type Err = NoSuchColor

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Color, <Color as FromStr>::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for Color

Source§

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

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

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 Resolvable for Color

Source§

fn from_config(config: &Value, context: &Context) -> Result<Color, Error>

Build from a config (a JSON value). Read more
Source§

fn from_any(any: Box<dyn Any>) -> Option<Self>
where Self: Sized + Any,

Build from an Any variable. Read more
Source§

impl Copy for Color

Source§

impl Eq for Color

Source§

impl StructuralPartialEq for Color

Auto Trait Implementations§

§

impl Freeze for Color

§

impl RefUnwindSafe for Color

§

impl Send for Color

§

impl Sync for Color

§

impl Unpin for Color

§

impl UnwindSafe for Color

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> With for T

Source§

fn wrap_with<U, F>(self, f: F) -> U
where F: FnOnce(Self) -> U,

Calls the given closure and return the result. Read more
Source§

fn with<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Calls the given closure on self.
Source§

fn try_with<E, F>(self, f: F) -> Result<Self, E>
where F: FnOnce(&mut Self) -> Result<(), E>,

Calls the given closure on self.
Source§

fn with_if<F>(self, condition: bool, f: F) -> Self
where F: FnOnce(&mut Self),

Calls the given closure if condition == true.