Struct ThemeDocument 

pub struct ThemeDocument {

    pub schema_version: u32,
    pub id: String,
    pub name: String,
    pub palette: Palette,
    pub emphasis: Emphasis,
    pub presence: Tone,
    pub shape: ThemeShape,
    pub density: ThemeDensity,
    pub type_: ThemeType,
    pub motion: ThemeMotion,
    pub material: ThemeMaterial,
    pub depth: Depth,
    pub response: Option<Response>,
    pub icons: Option<ThemeIcons>,
}

A theme, as data. See the module documentation.

Fields

schema_version: u32

Read through [THEME_SCHEMAS_READ]: an older schema it lists is held as the current one.

id: String

name: String

palette: Palette

emphasis: Emphasis

presence: Tone

Lightness and chroma of the twelve presence colours.

shape: ThemeShape

density: ThemeDensity

type_: ThemeType

motion: ThemeMotion

material: ThemeMaterial

depth: Depth

How surfaces stand off what is below them.

response: Option<Response>

How the shared components answer the pointer (hover and press). A document that states none takes the stock response, or the still one when its motion curve is none.

icons: Option<ThemeIcons>

How icons are drawn: the outline’s width. Absent keeps the design language’s 1.5.

Implementations

impl ThemeDocument

pub fn stock(id: &str, name: &str, palette: Palette) -> ThemeDocument

A document with the stock roles around palette.

pub fn validate(&self) -> Result<(), &'static str>

Structural check: the schema, the text fields, and every number finite and inside the band its role admits. A document that fails is not a theme. Legibility is Self::findings.

pub fn findings(&self) -> Vec<ContrastFinding>

Every contrast floor this document misses as authored, whoever wears it (each presence hue as the focus ring), worst ratio first per pair. Theme Studio refuses to save a document with findings; the runtime repairs one that arrives anyway.

pub fn is_dark(&self) -> bool

Whether ink is light on this document’s surfaces.

pub fn in_high_contrast(&self) -> ThemeDocument

The same document as the high-contrast palette of its polarity: shape, density, type and motion stay; the palette, presence tone and emphasis become the AAA ones and the material turns opaque.

Trait Implementations

impl Clone for ThemeDocument

fn clone(&self) -> ThemeDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThemeDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ThemeDocument

fn deserialize<__D>( __deserializer: __D, ) -> Result<ThemeDocument, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ThemeDocument

fn eq(&self, other: &ThemeDocument) -> 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 ThemeDocument

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ThemeDocument