Skip to main content

ThemeFile

Struct ThemeFile 

Source
pub struct ThemeFile {
    pub theme: Theme,
    pub widgets: Option<WidgetTheme>,
}
Available on crate feature serde only.
Expand description

A parsed theme document: a base Theme plus optional WidgetTheme slots.

Use ThemeFile::from_toml_str / ThemeFile::load to construct one, then feed theme into crate::Context::set_theme and widgets into crate::RunConfig::widget_theme.

§Example

use slt::ThemeFile;

let tf = ThemeFile::from_toml_str(r##"
[theme]
primary = "#ff0000"

[widgets.button]
fg = "#ffffff"
"##).unwrap();
assert_eq!(tf.theme.primary, slt::Color::Rgb(255, 0, 0));
assert!(tf.widgets.is_some());

Fields§

§theme: Theme

The base theme (the [theme] table). Missing fields fall back to Theme::dark().

§widgets: Option<WidgetTheme>

Optional per-widget color overrides (the [widgets] table).

Implementations§

Source§

impl ThemeFile

Source

pub fn from_toml_str(src: &str) -> Result<ThemeFile, ThemeLoadError>

Parse a ThemeFile from a TOML string.

§Errors

Returns ThemeLoadError::Parse for malformed TOML or a shape that does not match the expected [theme] / [widgets] layout.

§Example
use slt::ThemeFile;

let tf = ThemeFile::from_toml_str("[theme]\nprimary = \"#00ff00\"\n").unwrap();
assert_eq!(tf.theme.primary, slt::Color::Rgb(0, 255, 0));
Source

pub fn to_toml_string(&self) -> Result<String, ThemeLoadError>

Serialize this ThemeFile back to a TOML string.

The output round-trips through ThemeFile::from_toml_str. Colors are emitted as human-friendly tokens (#rrggbb, named, or indexed:N).

§Errors

Returns ThemeLoadError::Parse if serialization fails (e.g. a value that TOML cannot represent).

§Example
use slt::{Theme, ThemeFile};

let tf = ThemeFile { theme: Theme::dracula(), widgets: None };
let toml = tf.to_toml_string().unwrap();
assert!(toml.contains("[theme]"));
Source

pub fn load(path: impl AsRef<Path>) -> Result<ThemeFile, ThemeLoadError>

Read and parse a ThemeFile from a TOML file at path.

§Errors

Returns ThemeLoadError::Io if the file cannot be read, or ThemeLoadError::Parse if its contents are not valid TOML.

§Example
use slt::ThemeFile;

let tf = ThemeFile::load("theme.toml").unwrap();
println!("primary = {:?}", tf.theme.primary);

Trait Implementations§

Source§

impl Clone for ThemeFile

Source§

fn clone(&self) -> ThemeFile

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ThemeFile

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ThemeFile

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ThemeFile

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,