Struct kpdb::Color

pub struct Color {
    pub red: u8,
    pub green: u8,
    pub blue: u8,
}

A structure representing a color (RGB).

Fields

red: u8

Red part of the color.

green: u8

Green part of the color.

blue: u8

Blue part of the color.

Implementations

impl Color

pub fn from_hex_string(hex: &str) -> Result<Color, ColorError>

Attempts to create a color from an hex string.

Errors

This function will return an error when the hex string is not a valid color.

Examples

use kpdb::Color;

let color = Color::from_hex_string("#abcdef")?;

pub fn to_hex_string(&self) -> String

Gets the hex string representation of the supplied color.

Examples

use kpdb::Color;

let color = Color { red: 171, green: 205, blue: 239 };
let hex = color.to_hex_string();

Trait Implementations

impl Clone for Color

fn clone(&self) -> Color

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Color

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

Formats the value using the given formatter.

impl Ord for Color

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Color> for Color

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Color> for Color

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

impl StructuralEq for Color

impl StructuralPartialEq for Color