colorsys 0.7.3

A module for color conversion and mutation. Works with RGB(a)( as hexadecimal too), HSL(a), CMYK color models and with ANSI color codes
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

use core::ops::{Add, AddAssign, Sub, SubAssign};

pub use ratio::CmykRatio;

use crate::consts::PERCENT_MAX;
use crate::Rgb;
use crate::units::{Alpha, GetColorUnits, Unit, Units};

mod ratio;
mod from;


/// The CMYK color model.
///
/// Has cyan, magenta, yellow, key (0.0..100.0) and optional `alpha` channel (0.0..1.0).
///
/// # Example
/// ```
/// use colorsys::Cmyk;
///
/// let mut cmyk = Cmyk::new(33.1, 999.9, 11.0, 0.0, None);
///
/// assert_eq!(cmyk.cyan(), 33.1);
/// assert_eq!(cmyk.magenta(), 100.0);
///
/// cmyk.set_yellow(73.0);
/// assert_eq!(cmyk.yellow(), 73.0);
///
/// let doubled_cmyk = &cmyk + &cmyk;
///
/// let units: [f64;4] = doubled_cmyk.into();
/// assert_eq!(units, [66.2,100.0,100.0,0.0]);
///
/// ```
#[derive(Debug, PartialEq, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Cmyk {
  pub(crate) units: Units,
}
ops_def!(Cmyk);


pub(crate) fn new_cmyk_units(c: f64, m: f64, y: f64, k: f64) -> Units {
  let p = Unit::new_percent;
  let ul = [p(c), p(m), p(y), p(k)];
  Units { len: 4, list: ul, alpha: Alpha::default() }
}

impl Cmyk {
  pub fn new(c: f64, m: f64, y: f64, k: f64, a: Option<f64>) -> Self {
    let mut u = new_cmyk_units(c, m, y, k);
    u.alpha.set_opt(a);
    u.restrict();
    Cmyk::from_units(u)
  }

  pub fn cyan(&self) -> f64 { self.units[0] }
  pub fn magenta(&self) -> f64 { self.units[1] }
  pub fn yellow(&self) -> f64 { self.units[2] }
  pub fn key(&self) -> f64 { self.units[3] }

  pub fn set_cyan(&mut self, c: f64) { self.units.list[0].set(c); }
  pub fn set_magenta(&mut self, m: f64) { self.units.list[1].set(m); }
  pub fn set_yellow(&mut self, y: f64) { self.units.list[2].set(y); }
  pub fn set_key(&mut self, k: f64) { self.units.list[3].set(k); }

  /// Returns same color in RGB color model
  /// # Example
  /// ```
  /// use colorsys::{Cmyk, Rgb, ApproxEq};
  ///
  /// let cmyk = Cmyk::from(&[0.0,0.0,100.0,0.0]);
  /// let rgb_from_cmyk = cmyk.as_rgb();
  /// assert!(rgb_from_cmyk.approx_eq(&Rgb::from([255,255,0])));
  ///
  /// ```
  pub fn as_rgb(&self) -> Rgb {
    self.into()
  }
  pub fn as_ratio(&self) -> CmykRatio {
    self.into()
  }

  pub(crate) fn from_units(u: Units) -> Cmyk {
    Cmyk { units: u }
  }
}


impl GetColorUnits for Cmyk {
  fn get_units(&self) -> &Units { &self.units }
  fn get_units_mut(&mut self) -> &mut Units { &mut self.units }
}


impl AsRef<Cmyk> for Cmyk {
  fn as_ref(&self) -> &Cmyk { self }
}

impl Default for Cmyk {
  fn default() -> Cmyk {
    Cmyk::from_units(new_cmyk_units(0.0, 0.0, 0.0, PERCENT_MAX))
  }
}