tinted-builder 0.13.0

A Tinted Theming template builder which uses yaml color schemes to generate theme files.
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

use ribboncurls::RibboncurlsError;
use thiserror::Error;

/// An error type representing the various errors that can occur when using tinted-builder
///
/// This error type is non-exhaustive, meaning additional variants may be added in future versions without
/// it being considered a breaking change. The enum variants cover a range of possible issues that might
/// arise during the processing of color schemes, including missing properties, deserialization errors,
/// and rendering issues.
#[non_exhaustive]
#[derive(Error, Debug)]
pub enum TintedBuilderError {
    /// Error indicating that a required property in the scheme is missing.
    ///
    /// This variant is used when a necessary property for the scheme's configuration is not found.
    #[error("missing scheme property: {0}")]
    SchemeMissingProperty(String),

    /// Error that occurs when YAML deserialization fails.
    ///
    /// This variant wraps the `serde_yaml::Error` and is used when there is an issue converting
    /// a YAML string into the corresponding Rust data structure.
    #[error("unable to deserialize yaml")]
    YamlDeserialize(#[from] serde_yaml::Error),

    /// Error that occurs during rendering using Ribboncurls.
    ///
    /// This variant wraps the `RibboncurlsError` and is used when an error is encountered while
    /// rendering a template or other content using Ribboncurls.
    #[error("unable to render")]
    RibboncurlsRender(#[from] RibboncurlsError),

    /// Error that occurs when a string slice cannot be converted to an integer with the given base.
    ///
    /// This variant wraps `std::num::ParseIntError` and is used when a string slice, such as a color
    /// value in hexadecimal format, fails to parse correctly.
    #[error("unable to convert string slice to integer with given base")]
    ColorRadix(#[from] std::num::ParseIntError),

    /// Error indicating that a hex color input is not formatted correctly.
    ///
    /// This variant is used when a color string that is expected to be in hex format does not match
    /// the expected format.
    #[error("hex input is not formatted correctly")]
    HexInputFormat,

    /// Error indicating that an invalid scheme variant was provided.
    ///
    /// This variant is used when an input string does not correspond to any valid scheme variant,
    /// such as "dark" or "light".
    #[error("invalid scheme variant: {0}")]
    InvalidSchemeVariant(String),

    /// Error indicating that an invalid scheme system was provided.
    ///
    /// This variant is used when an input string does not correspond to any valid scheme system
    #[error("invalid scheme system: {0}")]
    InvalidSchemeSystem(String),

    /// Error indicating that an invalid color name was provided.
    ///
    /// This variant is used when an input string does not correspond to any valid color name.
    #[error("invalid color name: {0}")]
    InvalidColorName(String),

    /// Error indicating that an invalid color variant was provided.
    ///
    /// This variant is used when an input string does not correspond to any valid color variant.
    #[error("invalid color variant: {0}")]
    InvalidColorVariant(String),

    /// Error indicating that an invalid color type was provided.
    ///
    /// This variant is used when an input string does not correspond to a valid color type.
    #[error("invalid color type: {0}")]
    InvalidColorType(String),

    /// Error indicating a `Color` conversion problem
    ///
    /// This variant is used when a color is not able to convert from one color to another
    #[error("unable to convert Color from \"{0}\" to \"{1}\"")]
    ColorConversion(String, String),

    /// Error indicating an unsupported color derivation was requested.
    ///
    /// This variant is used when attempting to derive a color from another color
    /// using an unsupported conversion path (e.g., deriving orange from blue).
    #[error("unsupported color derivation: cannot derive {target} from {from_color} (supported: {supported_derivations})")]
    UnsupportedColorDerivation {
        from_color: String,
        target: String,
        supported_derivations: String,
    },

    /// Error indicating an inability to convert from type
    ///
    /// This variant is used when attempting to derive a color from another color
    /// using an unsupported conversion path (e.g., deriving orange from blue).
    #[error("unable to convert from type: {0}")]
    UnableToConvertFrom(String),
}