osb 0.3.0

A fast, fully-fledged, scalable and secure implementation of the .osb storyboard file format
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

/// A color type
///
/// Contains an `r`, `g` and `b` value that ranges between 0 and 255
#[derive(Debug, Copy, Clone, PartialEq)]
pub struct Color {
    r: i32,
    g: i32,
    b: i32,
}

impl Color {
    /// Allows you to create a `Color`
    ///
    /// Example:
    /// ```
    /// use osb::utils::Color;
    /// let my_color = Color::from(42, 42, 42);
    /// ```
    pub fn from(r: i32, g: i32, b: i32) -> Self {
        let (mut r, mut g, mut b) = (r, g, b);
        if r < 0 {
            r = 0;
        } else if r > 255 {
            r = 255;
        }

        if g < 0 {
            g = 0;
        } else if g > 255 {
            g = 255;
        }

        if b < 0 {
            b = 0;
        } else if b > 255 {
            b = 255;
        }

        Self { r, g, b }
    }

    /// Returns the red value of a `Color`
    ///
    /// Example:
    /// ```
    /// use osb::utils::Color;
    /// assert_eq!(Color::red().r(), 255);
    /// ```
    pub fn r(&self) -> i32 {
        self.r
    }

    /// Returns the green value of a `Color`
    ///
    /// Example:
    /// ```
    /// use osb::utils::Color;
    /// assert_eq!(Color::green().g(), 255);
    /// ```
    pub fn g(&self) -> i32 {
        self.g
    }

    /// Returns the blue value of a `Color`
    ///
    /// Example:
    /// ```
    /// use osb::utils::Color;
    /// assert_eq!(Color::blue().b(), 255);
    /// ```
    pub fn b(&self) -> i32 {
        self.b
    }

    /// Returns a black color
    ///
    /// Example:
    /// ```
    /// use osb::utils::Color;
    /// assert_eq!(Color::black(), Color::from(0, 0, 0));
    /// ```
    pub fn black() -> Self {
        Self { r: 0, g: 0, b: 0 }
    }

    /// Returns a red color
    ///
    /// Example:
    /// ```
    /// use osb::utils::Color;
    /// assert_eq!(Color::red(), Color::from(255, 0, 0));
    /// ```
    pub fn red() -> Self {
        Self { r: 255, g: 0, b: 0 }
    }

    /// Returns a green color
    ///
    /// Example:
    /// ```
    /// use osb::utils::Color;
    /// assert_eq!(Color::green(), Color::from(0, 255, 0));
    /// ```
    pub fn green() -> Self {
        Self { r: 0, g: 255, b: 0 }
    }

    /// Returns a blue color
    ///
    /// Example:
    /// ```
    /// use osb::utils::Color;
    /// assert_eq!(Color::blue(), Color::from(0, 0, 255));
    /// ```
    pub fn blue() -> Self {
        Self { r: 0, g: 0, b: 255 }
    }

    /// Returns a white color
    ///
    /// Example:
    /// ```
    /// use osb::utils::Color;
    /// assert_eq!(Color::white(), Color::from(255, 255, 255));
    /// ```
    pub fn white() -> Self {
        Self {
            r: 255,
            g: 255,
            b: 255,
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::utils::Color;

    #[test]
    fn out_of_range() {
        assert_eq!(Color::from(-1, -200, -42), Color::black());
        assert_eq!(Color::from(300, 300, 300), Color::white());
    }
}