Struct ColorContrast 

pub struct ColorContrast;

Provides utilities for calculating and ensuring color contrast ratios.

Used to determine if text colors meet WCAG accessibility standards when displayed on specific background colors.

Implementations

impl ColorContrast

pub fn calculate_luminance(r: u8, g: u8, b: u8) -> f64

Calculates the relative luminance of a color.

Arguments

• u8 - Red component (0-255)
• u8 - Green component (0-255)
• u8 - Blue component (0-255)

Returns

• f64 - Relative luminance value (0.0-1.0)

pub fn calculate_contrast_ratio( color1: (u8, u8, u8), color2: (u8, u8, u8), ) -> f64

Calculates the contrast ratio between two colors.

Arguments

• (u8, u8, u8) - First color RGB values
• (u8, u8, u8) - Second color RGB values

Returns

• f64 - Contrast ratio (1.0-21.0)

pub fn extract_rgb_from_color_type(color: &ColorType) -> (u8, u8, u8)

Extracts RGB values from ColorType.

Arguments

• &ColorType - Color to extract RGB from

Returns

• (u8, u8, u8) - RGB values

pub fn has_sufficient_contrast( text_color: &ColorType, bg_color: &ColorType, ) -> bool

Checks if two colors have sufficient contrast for readability.

Arguments

• &ColorType - Text color
• &ColorType - Background color

Returns

• bool - Whether contrast is sufficient (ratio >= 4.5)

pub fn ensure_sufficient_contrast( text_color: &ColorType, bg_color: &ColorType, ) -> ColorType

Automatically adjusts text color to ensure sufficient contrast with background.

Arguments

• &ColorType - Original text color
• &ColorType - Background color

Returns

• ColorType - Adjusted text color with sufficient contrast

pub fn darken_color_for_contrast( text_rgb: (u8, u8, u8), bg_rgb: (u8, u8, u8), ) -> ColorType

Darkens a color while preserving its hue for better contrast against light backgrounds.

Arguments

• (u8, u8, u8) - Original text color RGB
• (u8, u8, u8) - Background color RGB

Returns

• ColorType - Darkened color with sufficient contrast

pub fn lighten_color_for_contrast( text_rgb: (u8, u8, u8), bg_rgb: (u8, u8, u8), ) -> ColorType

Lightens a color while preserving its hue for better contrast against dark backgrounds.

Arguments

• (u8, u8, u8) - Original text color RGB
• (u8, u8, u8) - Background color RGB

Returns

• ColorType - Lightened color with sufficient contrast

Trait Implementations

impl Clone for ColorContrast

fn clone(&self) -> ColorContrast

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColorContrast

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

Formats the value using the given formatter.

impl Default for ColorContrast

fn default() -> ColorContrast

Returns the “default value” for a type.

impl Hash for ColorContrast

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

where __H: Hasher,

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 Ord for ColorContrast

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

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

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

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 ColorContrast

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

impl Eq for ColorContrast

impl StructuralPartialEq for ColorContrast