Struct Base16Palette 

pub struct Base16Palette {

    pub name: &'static str,
    pub author: &'static str,
    pub slug: &'static str,
    pub base00: Color,
    pub base01: Color,
    pub base02: Color,
    pub base03: Color,
    pub base04: Color,
    pub base05: Color,
    pub base06: Color,
    pub base07: Color,
    pub base08: Color,
    pub base09: Color,
    pub base0a: Color,
    pub base0b: Color,
    pub base0c: Color,
    pub base0d: Color,
    pub base0e: Color,
    pub base0f: Color,
}

A Base16Palette defines a color palette based on the Base16 styling guidelines. These color codes are typically used to create themes for syntax highlighting, terminal emulators, and other developer tools. Each field represents a different element of the user interface that can be customized. Base16 aims to group similar language constructs with a single colour. For example, floats, ints, and doubles would belong to the same colour group. The colours for the default theme were chosen to be easily separable, but scheme designers should pick whichever colours they desire, e.g. base0B (green by default) could be replaced with red. There are, however, some general guidelines below that stipulate which base0B should be used to highlight each construct when designing templates for editors.

Colours base00 to base07 are typically variations of a shade and run from darkest to lightest. These colours are used for foreground and background, status bars, line highlighting and such. colours base08 to base0F are typically individual colours used for types, operators, names and variables. In order to create a dark theme, colours base00 to base07 should span from dark to light. For a light theme, these colours should span from light to dark.

Fields

name: &'static str

Name

author: &'static str

Author

slug: &'static str

Default Background

base00: Color

Default Background

base01: Color

Lighter Background (Used for status bars, line number and folding marks)

base02: Color

Selection Background (Settings where you need to highlight text, such as find results)

base03: Color

Comments, Invisibles, Line Highlighting

base04: Color

Dark Foreground (Used for status bars)

base05: Color

Default Foreground, Caret, Delimiters, Operators

base06: Color

Light Foreground (Not often used, could be used for hover states or dividers)

base07: Color

Light Background (Probably at most for cursor line background color)

base08: Color

Variables, XML Tags, Markup Link Text, Markup Lists, Diff Deleted

base09: Color

Integers, Boolean, Constants, XML Attributes, Markup Link Url

base0a: Color

Classes, Markup Bold, Search Text Background

base0b: Color

Strings, Inherited Class, Markup Code, Diff Inserted

base0c: Color

Support, Regular Expressions, Escape Characters, Markup Quotes

base0d: Color

Functions, Methods, Attribute IDs, Headings

base0e: Color

Keywords, Storage, Selector, Markup Bold, Diff Changed

base0f: Color

Deprecated, Opening/Closing Embedded Language Tags, e.g. `

Implementations

impl Base16Palette

pub fn from_yaml(file: impl Into<PathBuf>) -> Result<Self, Base16PaletteError>

Loads a Base16Palette instance from a YAML file.

Given a file path, this function uses Figment’s Yaml provider to read and parse the YAML content into a Base16Palette instance. This allows for loading the color palette configuration from a YAML-formatted file.

Arguments

• file: The file path pointing to the YAML configuration file. The file path type is generic and can be any type that implements Into<PathBuf>.

Returns

If the function is successful, it returns Ok(Base16Palette), the loaded palette instance. If an error occurs during reading or parsing the file, it returns a Base16PaletteError.

Examples

let palette_result = Base16Palette::from_yaml("path_to_file.yaml");

pub fn from_toml(file: impl Into<PathBuf>) -> Result<Self, Base16PaletteError>

Loads a Base16Palette instance from a TOML file.

Given a file path, this function uses Figment’s Toml provider to read and parse the TOML content into a Base16Palette instance. This allows for loading the color palette configuration from a TOML-formatted file.

Arguments

• file: The file path pointing to the TOML configuration file. The file path type is generic and can be any type that implements Into<PathBuf>.

Returns

If the function is successful, it returns Ok(Base16Palette), the loaded palette instance. If an error occurs during reading or parsing the file, it returns a Base16PaletteError.

Examples

let palette_result = Base16Palette::from_toml("path_to_file.toml");

Trait Implementations

impl Clone for Base16Palette

fn clone(&self) -> Base16Palette

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Base16Palette

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

Formats the value using the given formatter.

impl Default for Base16Palette

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Base16Palette

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Base16Palette

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

where __S: Serializer,

Serialize this value into the given Serde serializer.