chocodye 1.1.3

A Rust library for changing the color of the chocobos' plumage in Final Fantasy XIV.
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

/// A category of dyes with similar hues.
#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
#[repr(u8)]
pub enum Category {{
    {variants}
}}

impl Category {{
    /// Contains all seven `Category` variants.
    pub const VALUES: [Category; 7] = [
        {associatedconstant_VALUES}
    ];

    /// Returns all the dyes belonging to `self`. Dyes belong to one and only one category.
    #[must_use]
    #[inline]
    pub const fn dyes(self) -> &'static [Dye] {{
        use Dye::*;
        match self {{
            {method_dyes}
        }}
    }}

    /// Returns a color representing `self`. Does not necessarily correspond to a dye.
    #[must_use]
    #[inline]
    pub const fn color(self) -> Rgb {{
        match self {{
            {method_color}
        }}
    }}

    /// Returns the variant name of `self` in kebab-case.
    ///
    /// # Examples
    ///
    /// ```
    /// use chocodye::Category;
    ///
    /// assert_eq!(Category::Purple.short_name(), "purple");
    /// ```
    #[must_use]
    #[inline]
    pub const fn short_name(self) -> &'static str {{
        match self {{
            {method_short_names}
        }}
    }}
}}