Color

Enum Color

pub enum Color {
Show 17 variants
    A98Rgb(A98Rgb),
    DisplayP3(DisplayP3),
    Hsv(Hsv),
    Hsl(Hsl),
    Hex(Hex),
    Hwb(Hwb),
    Lab(Lab),
    Lch(Lch),
    LinearRgb(LinearRgb),
    Named(Named),
    Oklab(Oklab),
    Oklch(Oklch),
    ProphotoRgb(ProphotoRgb),
    Rec2020(Rec2020),
    Srgb(Srgb),
    XyzD50(XyzD50),
    XyzD65(XyzD65),
}

Variants§

A98Rgb(A98Rgb)

DisplayP3(DisplayP3)

Hsv(Hsv)

Hsl(Hsl)

Hex(Hex)

Hwb(Hwb)

Lab(Lab)

Lch(Lch)

LinearRgb(LinearRgb)

Named(Named)

Oklab(Oklab)

Oklch(Oklch)

ProphotoRgb(ProphotoRgb)

Rec2020(Rec2020)

Srgb(Srgb)

XyzD50(XyzD50)

XyzD65(XyzD65)

Implementations§

impl Color

pub fn color_space(&self) -> Option<ColorSpace>

Returns the ColorSpace of this colour, if it maps to a bounded RGB gamut.

Perceptual and CIE spaces (Lab, Lch, Oklab, Oklch, XyzD50, XyzD65) return None — they can represent colours outside any single RGB gamut.

pub fn in_gamut_of(&self, space: ColorSpace) -> bool

Returns true if this colour can be represented in space without clamping.

If the colour’s own space is a subset of space and the colour is in gamut of its own space, this returns true without conversion. Otherwise the colour is converted to the target space (via XyzD65) and the RGB channels are checked against [0,1].

impl Color

pub fn with_alpha(self, alpha: f32) -> Self

Returns a copy of this colour with a new alpha value (0.0–100.0).

For Named colours (which are always fully opaque), setting a non-100 alpha converts to Srgb. For Hex, the colour is round-tripped through Srgb to apply the new alpha.

Trait Implementations§

impl Clone for Color

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

impl Debug for Color

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

Formats the value using the given formatter. Read more

impl Display for Color

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

Formats the value using the given formatter. Read more

impl From<Color> for A98Rgb

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Color

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for DisplayP3

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Hex

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Hsl

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Hsv

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Hwb

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Lab

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Lch

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for LinearRgb

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Oklab

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Oklch

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for ProphotoRgb

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Rec2020

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Rgb

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for RgbColor

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for Srgb

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for XyzD50

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Color> for XyzD65

fn from(value: Color) -> Self

Converts to this type from the input type.

impl Gamut for Color

fn in_gamut(&self) -> bool

Returns true if all colour channels are within the natural bounds of this colour space. Alpha is not considered — it is always clamped on construction.

fn clamp_to_gamut(&self) -> Self

Returns a copy with all colour channels naively clamped to the natural bounds. Read more

fn map_to_gamut(self) -> Self

Perceptually maps this colour into gamut. Read more

impl PartialEq for Color

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.

impl ToAlpha for Color

fn to_alpha(&self) -> f32

Returns a number between 0.0 (fully transparent) to 100.0 (fully opaque).

fn fully_opaque(&self) -> bool

Returns true if the alpha of this colour is 100.0

fn fully_transparent(&self) -> bool

Returns true if the alpha of this colour is 0.0

impl TryFrom<Color> for Named

type Error = ToNamedError

The type returned in the event of a conversion error.

fn try_from(value: Color) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Color

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§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<C, T> ColorDistance<T> for C
where C: Copy, Lab: From<C> + From<T>,

fn close_to(&self, other: T, tolerance: f64) -> bool

Compares self to other via delta_e, checking that the result is less than or equal to tolerance. Read more

fn far_from(&self, other: T, tolerance: f64) -> bool

Compares self to other via delta_e, checking that the result is greater than or equal to tolerance. Read more

fn delta_e(&self, other: T) -> f64

This uses the CIEDE2000 Delta E formula difference between self and other. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined

fn blink(&self) -> BlinkDisplay<'_, Self>

Make the text blink

fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>

Make the text blink (but fast!)

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either [OwoColorize::fg] or a color-specific method, such as [OwoColorize::green], Read more

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either [OwoColorize::bg] or a color-specific method, such as [OwoColorize::on_yellow], Read more

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<C, T> WcagColorContrast<T> for C
where C: Copy, T: Copy, Srgb: From<C> + From<T>,

fn wcag_contrast_ratio(&self, other: T) -> f64

Calculate the contrast ratio between self and other. colors according to WCAG 2.1. Returns a value between 1:1 and 21:1 Read more

fn wcag_level(&self, other: T) -> WcagLevel

Get the WCAG level for the contrast between self and other. Read more

fn find_minimum_contrast<Space>( &self, other: T, level: WcagLevel, ) -> Option<Space>
where Self: WcagColorContrast<Space>, Space: ColorMix<Self, T> + From<Self> + From<T> + Copy + PartialEq + Debug, Srgb: From<Space>, Hex: From<Space>,

Find the closest color that meets a specific WCAG level against a background. Read more