Struct color_conv::hsl::Hsl

pub struct Hsl {
    pub hue: u16,
    pub saturation: u8,
    pub lightness: u8,
}

A representation of the HSL (cyan, magenta, yellow, key) color format.

Fields

hue: u16

Hue value (in degrees)

saturation: u8

Saturation percentage

lightness: u8

Lightness percentage

Implementations

impl Hsl

pub fn new(hue: u16, saturation: u8, lightness: u8) -> Result<Self, Error>

Returns a Result containing a new Hsl object given hue, saturation, and lightness values. Will return an Error if either the saturation or lightness are larger than 100 due to the fact that they represent percentages or the hue is greater than 360 because it represents a degree value.

Arguments

• hue - the hue value of the color
• saturation - the saturation value of the color
• lightness - the lightness value of the color

Examples

use color_conv::Hsl;
let cyan = Hsl::new(180, 100, 50)?;

pub fn new_unchecked(hue: u16, saturation: u8, lightness: u8) -> Self

See Hsl::new. Does not perform check to ensure that all parameters are valid. This is useful for when you know more than the compiler about which values are being passed to the method.

Examples

use color_conv::Hsl;
let cyan = Hsl::new_unchecked(180, 100, 50);

Trait Implementations

impl Clone for Hsl

fn clone(&self) -> Hsl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Color for Hsl

fn to_rgb(self) -> Rgb

Convert to Rgb

fn to_cmyk(self) -> Cmyk

Convert to Cmyk with the possibility of failing if any of the percentage values are above 100

fn to_hex_string(self) -> String

Convert to a String containing the hex code of the color prefixed with a hashtag (#)

fn to_hsl(self) -> Hsl

Convert to Hsl with the possibility of failing if any of the percentage values are above 100 or degree values are above 360

impl Copy for Hsl

impl Debug for Hsl

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

Formats the value using the given formatter.

impl Display for Hsl

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

Formats the value using the given formatter.

impl Eq for Hsl

impl Hash for Hsl

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Hsl> for Hsl

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

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

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

This method tests for !=.

impl StructuralEq for Hsl

impl StructuralPartialEq for Hsl