Enum Scheme 

#[non_exhaustive]
pub enum Scheme {
    Base16(Scheme),
    Base24(Scheme),
    Tinted8(Box<Scheme>),
}

Enum representing schemes for different scheme systems. This enum is non-exhaustive, meaning additional variants may be added in future versions without it being considered a breaking change.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Base16(Scheme)

Base16 variant with base16::Scheme deserialized content.

Base24(Scheme)

Base24 variant with base24::Scheme deserialized content.

Tinted8(Box<Scheme>)

Tinted8 scheme system with tinted8::Scheme deserialized content.

Implementations

impl Scheme

pub fn from_yaml(yaml: &str) -> Result<Self, TintedBuilderError>

Parse a YAML string into a Scheme, auto-detecting the system.

Inspects the system field (top-level or nested under scheme) to determine which variant to deserialize. Defaults to Base16 if no system field is found.

Errors

Returns a TintedBuilderError if the YAML is malformed, the system is unrecognised, or the scheme fails validation.

pub fn get_scheme_author(&self) -> String

Returns the author of the scheme.

pub fn get_scheme_description(&self) -> String

Returns the optional description (empty string when missing).

pub fn get_scheme_name(&self) -> String

Returns the human-readable name of the scheme.

pub fn get_scheme_slug(&self) -> String

Returns the scheme slug.

pub const fn get_scheme_system(&self) -> SchemeSystem

Returns the scheme system for this variant.

pub fn get_scheme_variant(&self) -> SchemeVariant

Returns the scheme variant (light or dark).

Trait Implementations

impl Clone for Scheme

fn clone(&self) -> Scheme

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Scheme

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.