Struct ColorPalette 

pub struct ColorPalette {
    pub colors: Vec<Color>,
    pub name: Option<String>,
}

An implementation of the Simple Color Palette format — a minimal JSON-based file format for defining color palettes.

A palette contains colors with optional names, and the palette itself can also have a name. Colors are stored in extended sRGB color space (wide gamut). While colors are serialized in their linear form, the API primarily works with non-linear (gamma-corrected) values since these better match human perception and are what most color pickers and design tools use.

use simple_color_palette::{ColorPalette, Color};

let palette = ColorPalette::new(
	vec![
		Color::new(1.0, 0.0, 0.0, None, Some("Red".into())),
		Color::new(0.0, 1.0, 0.0, None, Some("Green".into())),
	],
	Some("Traffic Lights".into()),
);

let path = std::path::Path::new("Traffic Lights.color-palette");

// Save palette
palette.write_to_file(path);

// Load palette
let loaded = ColorPalette::read_from_file(path);

Fields

colors: Vec<Color>

List of colors in the palette.

name: Option<String>

Optional name of the palette.

Implementations

impl ColorPalette

pub fn new(colors: Vec<Color>, name: Option<String>) -> Self

Creates a new color palette with the specified colors and optional name.

pub fn write_to_file<P: AsRef<Path>>(&self, path: P) -> Result<(), PaletteError>

Writes the palette to a file in the Simple Color Palette format.

• path: The file path to write the palette to. Use the .color-palette file extension.

pub fn read_from_file<P: AsRef<Path>>(path: P) -> Result<Self, PaletteError>

Reads a palette from a file in the Simple Color Palette format.

• path: The file path to read the palette from.

Trait Implementations

impl Clone for ColorPalette

fn clone(&self) -> ColorPalette

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColorPalette

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

Formats the value using the given formatter.

impl Default for ColorPalette

fn default() -> ColorPalette

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ColorPalette

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ColorPalette

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

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

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 Serialize for ColorPalette

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ColorPalette