Struct Theme 

pub struct Theme { /* private fields */ }

Implementations

impl Theme

pub fn new() -> Self

Creates an empty theme.

pub fn from_styles(styles: BTreeMap<String, Style>) -> Self

Creates a theme from a style map after normalizing capture names.

pub fn from_parts( styles: BTreeMap<String, Style>, ui: BTreeMap<String, Style>, ) -> Self

Creates a theme from syntax-style and UI-role maps after normalization.

pub fn insert( &mut self, capture_name: impl AsRef<str>, style: Style, ) -> Option<Style>

Inserts or replaces a style for a capture name.

Capture names are normalized (trimmed, lowercased, optional @ removed). Returns the previously associated style, if any.

pub fn styles(&self) -> &BTreeMap<String, Style>

Returns the internal normalized style map.

pub fn insert_ui( &mut self, role_name: impl AsRef<str>, style: Style, ) -> Option<Style>

Inserts or replaces a UI role style.

Role names are normalized like capture names. Returns the previously associated style, if any.

pub fn ui_styles(&self) -> &BTreeMap<String, Style>

Returns the internal normalized UI role map.

pub fn get_exact(&self, capture_name: &str) -> Option<&Style>

Returns the exact style for a capture after normalization.

pub fn get_ui_exact(&self, role_name: &str) -> Option<&Style>

Returns the exact UI role style after normalization.

pub fn resolve(&self, capture_name: &str) -> Option<&Style>

Resolves a style using dotted-name fallback and finally normal.

For example, comment.documentation falls back to comment before attempting normal.

pub fn resolve_ui(&self, role_name: &str) -> Option<Style>

Resolves a UI role from explicit UI map entries with compatibility fallbacks.

This method first checks the dedicated ui map, then falls back to legacy entries in styles for compatibility with older themes.

pub fn resolve_ui_role(&self, role: UiRole) -> Option<Style>

Resolves a typed UI role from explicit UI entries and fallbacks.

pub fn default_terminal_colors(&self) -> (Option<Rgb>, Option<Rgb>)

Returns the theme default terminal foreground/background colors.

Values are resolved from UI roles first (default_fg, default_bg), then from styles.normal.

pub fn from_json_str(input: &str) -> Result<Self, ThemeError>

Parses a theme from JSON.

Both wrapped ({ "styles": { ... } }) and flat style documents are accepted.

Errors

Returns an error if the JSON cannot be parsed.

pub fn from_toml_str(input: &str) -> Result<Self, ThemeError>

Parses a theme from TOML.

Errors

Returns an error if the TOML cannot be parsed.

pub fn from_builtin(theme: BuiltinTheme) -> Result<Self, ThemeError>

Loads a built-in theme from embedded JSON.

Errors

Returns an error if embedded theme JSON fails to parse.

pub fn from_builtin_name(name: &str) -> Result<Self, ThemeError>

Loads a built-in theme from a name or alias.

Errors

Returns ThemeError::UnknownBuiltinTheme for unknown names.

Trait Implementations

impl Clone for Theme

fn clone(&self) -> Theme

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Theme

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

Formats the value using the given formatter.

impl Default for Theme

fn default() -> Theme

Returns the “default value” for a type.

impl PartialEq for Theme

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

impl StructuralPartialEq for Theme