Struct Scheme

pub struct Scheme {
    pub scheme: String,
    pub author: String,
    pub slug: String,
    pub colors: BTreeMap<BaseIndex, RgbColor>,
}

type representing a base16 scheme

Example

use base16_color_scheme::{Scheme, Template};

let template = Template::new("\
{{scheme-name}} {{scheme-slug}} {{scheme-author}}
{{base00-hex}} {{base00-hex-bgr}}
{{base00-hex-r}} {{base00-hex-g}} {{base00-hex-b}}
{{base00-rgb-r}} {{base00-rgb-g}} {{base00-rgb-b}}
{{base00-dec-r}} {{base00-dec-g}} {{base00-dec-b}}
{{base00-hsl-h}} {{base00-hsl-s}} {{base00-hsl-l}}").unwrap();

let mut scheme: Scheme = serde_yaml::from_str(r#"
scheme: "Scheme Name"
author: "Scheme Author"
base00: "7cafc2"
"#).unwrap();
scheme = scheme.create_slug();

println!("{}", template.render(&scheme));
assert_eq!(
    template.render(&scheme),
    "\
Scheme Name scheme-name Scheme Author
7cafc2 c2af7c
7c af c2
124 175 194
0.49 0.69 0.76
196.29 0.36 0.62");

Serialization / Deserialization

When deserializing Scheme requires the fields scheme and author, ignores the field scheme-slug, and accepts any number of fields between base00 and baseFF, (any combination of uppercase and lowercase, so baseab, baseAB, and baseAb all work.) though for a normal base16 theme it should have at least base00 to base0F.

Because scheme-slug is not created while deserialization it has to be inserted manually. Either by setting Scheme::slug manually, or using Scheme::create_slug.

When serializing Scheme it first serializes Scheme::scheme and Scheme::author then ignores Scheme::slug as per specification and afterwards serializes all colors contained in Scheme::colors ordered by the field number.
(base00, base01, base05 etc.)

Fields

scheme: String

author: String

slug: String

colors: BTreeMap<BaseIndex, RgbColor>

Implementations

impl Scheme

pub fn scheme_name(&self) -> &str

pub fn scheme_slug(&self) -> &str

pub fn create_slug(self) -> Self

Fill Self::slug based on Self::scheme.

see create_slug

pub fn scheme_author(&self) -> &str

pub fn color(&self, _: ColorField) -> Option<RgbColorFormatter>

Look up the field in Self::color and return a formatter for it.
(If the field exists.)

Trait Implementations

impl Clone for Scheme

fn clone(&self) -> Scheme

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Content for Scheme

fn is_truthy(&self) -> bool

Marks whether this content is truthy. Used when attempting to render a section.

fn capacity_hint(&self, _tpl: &Template<'_>) -> usize

How much capacity is likely required for all the data in this Content for a given Template.

fn render_field_escaped<E: Encoder>( &self, _hash: u64, name: &str, encoder: &mut E, ) -> Result<bool, E::Error>

Render a field by the hash or string of its name.

fn render_field_inverse<C, E>( &self, _hash: u64, name: &str, section: Section<'_, C>, encoder: &mut E, ) -> Result<bool, E::Error>

where C: ContentSequence, E: Encoder,

Render a field, by the hash of or string its name, as an inverse section. If successful, returns true if the field exists in this content, otherwise false.

fn render_escaped<E>( &self, _encoder: &mut E, ) -> Result<(), <E as Encoder>::Error>

where E: Encoder,

Renders self as a variable to the encoder.

fn render_unescaped<E>( &self, encoder: &mut E, ) -> Result<(), <E as Encoder>::Error>

where E: Encoder,

Renders self as a variable to the encoder.

fn render_section<C, E>( &self, section: Section<'_, C>, encoder: &mut E, ) -> Result<(), <E as Encoder>::Error>

where C: ContentSequence, E: Encoder,

Render a section with self.

fn render_inverse<C, E>( &self, section: Section<'_, C>, encoder: &mut E, ) -> Result<(), <E as Encoder>::Error>

where C: ContentSequence, E: Encoder,

Render a section with self.

fn render_field_unescaped<E>( &self, _hash: u64, _name: &str, _encoder: &mut E, ) -> Result<bool, <E as Encoder>::Error>

where E: Encoder,

Render a field by the hash or string of its name.

fn render_field_section<C, E>( &self, _hash: u64, _name: &str, _section: Section<'_, C>, _encoder: &mut E, ) -> Result<bool, <E as Encoder>::Error>

where C: ContentSequence, E: Encoder,

Render a field by the hash or string of its name, as a section. If successful, returns true if the field exists in this content, otherwise false.

impl Debug for Scheme

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

Formats the value using the given formatter.

impl Default for Scheme

fn default() -> Scheme

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Scheme

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for Scheme

fn cmp(&self, other: &Scheme) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Scheme

fn eq(&self, other: &Scheme) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Scheme

fn partial_cmp(&self, other: &Scheme) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Scheme

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Scheme

impl StructuralPartialEq for Scheme