inno 0.4.2

Library for reading Inno Setup executables
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189

use std::fmt;

use zerocopy::{FromBytes, Immutable, KnownLayout, LittleEndian, U32};

/// An Inno Color stored in Little-Endian byte order.
#[derive(Clone, Copy, Default, Eq, PartialEq, FromBytes, Immutable, KnownLayout)]
#[repr(transparent)]
pub struct Color(U32<LittleEndian>);

impl Color {
    /// Creates a new Color from an `rgba` value.
    ///
    /// # Examples
    ///
    /// ```
    /// use inno::header::Color;
    ///
    /// let color = Color::new(0xFFC8E10A);
    /// assert_eq!(color.to_string(), "#FFC8E10A");
    /// ```
    #[must_use]
    #[inline]
    pub const fn new(rgba: u32) -> Self {
        Self(U32::new(rgba))
    }

    /// Creates a new Color from a `red`, `green`, `blue` and `alpha`.
    ///
    /// # Examples
    ///
    /// ```
    /// use inno::header::Color;
    ///
    /// let color = Color::new_rgba(0xFF, 0xC8, 0xE1, 0xA);
    /// assert_eq!(color.to_string(), "#FFC8E10A");
    /// ```
    #[must_use]
    pub const fn new_rgba(red: u8, green: u8, blue: u8, alpha: u8) -> Self {
        Self(U32::from_bytes([alpha, blue, green, red]))
    }

    /// Returns the `red`, `green`, `blue` and `alpha` values as a tuple.
    ///
    /// # Examples
    ///
    /// ```
    /// use inno::header::Color;
    ///
    /// let color = Color::new_rgba(0x12, 0x34, 0x56, 0x78);
    /// assert_eq!(color.to_rgba(), (0x12, 0x34, 0x56, 0x78));
    /// ```
    #[must_use]
    pub const fn to_rgba(self) -> (u8, u8, u8, u8) {
        let [alpha, blue, green, red] = self.0.to_bytes();
        (red, green, blue, alpha)
    }

    /// Returns the `red`, `green`, `blue`, and `alpha` values as an array.
    ///
    /// # Examples
    ///
    /// ```
    /// use inno::header::Color;
    ///
    /// let color = Color::new_rgba(0x12, 0x34, 0x56, 0x78);
    /// assert_eq!(color.to_bytes(), [0x12, 0x34, 0x56, 0x78]);
    /// ```
    #[must_use]
    pub const fn to_bytes(self) -> [u8; size_of::<u32>()] {
        let [alpha, blue, green, red] = self.0.to_bytes();
        [red, green, blue, alpha]
    }

    /// Returns the inner `u32`.
    ///
    /// # Examples
    ///
    /// ```
    /// use inno::header::Color;
    ///
    /// let color = Color::new_rgba(0x12, 0x34, 0x56, 0x78);
    /// assert_eq!(color.get(), 0x12345678);
    /// ```
    #[must_use]
    #[inline]
    pub const fn get(self) -> u32 {
        self.0.get()
    }

    /// Returns the `red` value.
    ///
    /// # Examples
    ///
    /// ```
    /// use inno::header::Color;
    ///
    /// let color = Color::new_rgba(0x12, 0x34, 0x56, 0x78);
    /// assert_eq!(color.red(), 0x12);
    /// ```
    #[must_use]
    pub const fn red(self) -> u8 {
        self.0.to_bytes()[3]
    }

    /// Returns the `green` value.
    ///
    /// # Examples
    ///
    /// ```
    /// use inno::header::Color;
    ///
    /// let color = Color::new_rgba(0x12, 0x34, 0x56, 0x78);
    /// assert_eq!(color.green(), 0x34);
    /// ```
    #[must_use]
    pub const fn green(self) -> u8 {
        self.0.to_bytes()[2]
    }

    /// Returns the `blue` value.
    ///
    /// # Examples
    ///
    /// ```
    /// use inno::header::Color;
    ///
    /// let color = Color::new_rgba(0x12, 0x34, 0x56, 0x78);
    /// assert_eq!(color.blue(), 0x56);
    /// ```
    #[must_use]
    pub const fn blue(self) -> u8 {
        self.0.to_bytes()[1]
    }

    /// Returns the `alpha` value.
    ///
    /// # Examples
    ///
    /// ```
    /// use inno::header::Color;
    ///
    /// let color = Color::new_rgba(0x12, 0x34, 0x56, 0x78);
    /// assert_eq!(color.alpha(), 0x78);
    /// ```
    #[must_use]
    pub const fn alpha(self) -> u8 {
        self.0.to_bytes()[0]
    }
}

impl fmt::Debug for Color {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let (red, green, blue, alpha) = self.to_rgba();
        write!(
            f,
            "Color(red={red}, green={green}, blue={blue}, alpha={alpha}, {self}",
        )
    }
}

impl fmt::Display for Color {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "#{:08X}", self.0)
    }
}

impl From<U32<LittleEndian>> for Color {
    fn from(rgba: U32<LittleEndian>) -> Self {
        Self(rgba)
    }
}

impl From<u32> for Color {
    fn from(rgba: u32) -> Self {
        Self::new(rgba)
    }
}

impl From<(u8, u8, u8, u8)> for Color {
    fn from((red, green, blue, alpha): (u8, u8, u8, u8)) -> Self {
        Self::new_rgba(red, green, blue, alpha)
    }
}

impl From<[u8; size_of::<u32>()]> for Color {
    fn from([red, green, blue, alpha]: [u8; size_of::<u32>()]) -> Self {
        Self::new_rgba(red, green, blue, alpha)
    }
}