Struct Theme 

pub struct Theme {
    pub meta: ThemeMeta,
    /* private fields */
}

A fully resolved theme ready for use.

Contains resolved palette colors, semantic tokens, composed styles, and gradients. Access colors by token name with color(), styles by name with style(), and gradients via gradient() (requires the gradients feature).

Fields

meta: ThemeMeta

Implementations

impl Theme

pub fn from_resolved(meta: ThemeMeta, resolved: ResolvedTheme) -> Self

Construct a Theme from pre-resolved data.

For most use cases, prefer load_from_str or load_from_file. Use this when you have already run the resolution pipeline yourself.

pub fn builder(name: impl Into<String>) -> ThemeBuilder

Start building a theme programmatically.

See ThemeBuilder for the full builder API.

pub fn color(&self, token: &str) -> OpalineColor

Look up a color by token name, falling back to palette, then FALLBACK.

pub fn try_color(&self, token: &str) -> Option<OpalineColor>

Strict color lookup — returns None if the token doesn’t exist.

pub fn has_token(&self, name: &str) -> bool

Check whether a token or palette name exists.

pub fn token_names(&self) -> Vec<&str>

All token names defined in this theme.

pub fn palette_names(&self) -> Vec<&str>

All palette color names defined in this theme.

pub fn style(&self, name: &str) -> OpalineStyle

Look up a style by name, returning Default if missing.

pub fn try_style(&self, name: &str) -> Option<&OpalineStyle>

Strict style lookup — returns None if the style doesn’t exist.

pub fn has_style(&self, name: &str) -> bool

Check whether a named style exists.

pub fn style_names(&self) -> Vec<&str>

All style names defined in this theme.

pub fn gradient(&self, name: &str, t: f32) -> OpalineColor

Sample a named gradient at position t. Returns FALLBACK if the gradient doesn’t exist or the feature is disabled.

pub fn try_gradient(&self, name: &str, t: f32) -> Option<OpalineColor>

Strict gradient sampling — returns None if the gradient doesn’t exist.

pub fn get_gradient(&self, name: &str) -> Option<&Gradient>

Get a reference to a named gradient for manual sampling.

pub fn has_gradient(&self, name: &str) -> bool

Check whether a named gradient exists.

pub fn gradient_names(&self) -> Vec<&str>

All gradient names defined in this theme.

pub fn is_dark(&self) -> bool

Whether this is a dark theme.

pub fn is_light(&self) -> bool

Whether this is a light theme.

pub fn register_default_token( &mut self, name: impl Into<String>, color: OpalineColor, )

Register a token only if the theme doesn’t already define it.

Use this for app-level derived tokens — TOML-defined values take priority so theme authors can override derivations.

pub fn register_token(&mut self, name: impl Into<String>, color: OpalineColor)

Register a token, overwriting any existing value.

pub fn register_default_style( &mut self, name: impl Into<String>, style: OpalineStyle, )

Register a style only if the theme doesn’t already define it.

pub fn register_style(&mut self, name: impl Into<String>, style: OpalineStyle)

Register a style, overwriting any existing value.

impl Theme

pub fn span<'a>( &self, style_name: &str, content: impl Into<Cow<'a, str>>, ) -> Span<'a>

Create a styled Span from a named style.

pub fn line<'a>( &self, style_name: &str, content: impl Into<Cow<'a, str>>, ) -> Line<'a>

Create a styled Line from a named style.

pub fn text<'a>( &self, style_name: &str, content: impl Into<Cow<'a, str>>, ) -> Text<'a>

Create a styled Text from a named style.

pub fn gradient_text(&self, gradient_name: &str, content: &str) -> Line<'static>

Create a Line with per-character gradient coloring.

impl Theme

pub fn crossterm_styled<D: Display>( &self, style_name: &str, content: D, ) -> StyledContent<D>

Apply a named style to content, producing a crossterm StyledContent.

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() -> Self

Returns the “default value” for a type.

impl OwoThemeExt for Theme

fn owo_style(&self, style_name: &str) -> Style

Build an owo_colors::Style from a named theme style.

fn owo_fg(&self, token: &str) -> Style

Build an owo_colors::Style with a token color as foreground.

fn owo_bg(&self, token: &str) -> Style

Build an owo_colors::Style with a token color as background.

impl ThemeCliExt for Theme

fn cli_rgb(&self, token: &str) -> (u8, u8, u8)

Get a token color as an RGB tuple for use with .truecolor().

fn cli_colored(&self, text: &str, token: &str) -> ColoredString

Apply a token color as foreground on text.

fn cli_gradient(&self, text: &str, gradient_name: &str) -> String

Apply a named gradient across a string, returning ANSI-escaped output.