Skip to main content

ThemePreset

Struct ThemePreset 

Source
pub struct ThemePreset(/* private fields */);
Expand description

One named built-in terminal theme.

The catalog is generated from the terminal palette files in the pinned iTerm2-Color-Schemes snapshot documented in urushi/THIRD_PARTY_NOTICES.md. Every source theme is present; Urushi does not select a preferred subset.

A terminal palette describes indexed colors, while an Urushi theme describes semantic UI roles. The conversion uses terminal foreground/background for text/background, ANSI red/green/yellow/blue for the corresponding semantic colors, neutral foreground/background blends for surface, text_muted, and border, and the background for accent_text.

use urushi::{ColorScheme, ThemePreset, ThemeSet};

let light = ThemePreset::get("Catppuccin Latte").unwrap();
let dark = ThemePreset::get("Catppuccin Mocha").unwrap();
assert_eq!(light.scheme(), ColorScheme::Light);
assert_eq!(dark.scheme(), ColorScheme::Dark);
let themes = ThemeSet::new(light.theme(), dark.theme());
assert_ne!(themes.light().tokens().background, themes.dark().tokens().background);

Implementations§

Source§

impl ThemePreset

Source

pub const fn all() -> &'static [Self]

Returns every built-in theme in name order.

Source

pub fn get(name: &str) -> Option<Self>

Finds a built-in theme by its exact name.

Source

pub const fn name(self) -> &'static str

Returns the source theme’s name.

Source

pub const fn scheme(self) -> ColorScheme

Returns whether this preset has a light or dark background.

Source

pub fn theme(self) -> Theme

Builds an Urushi theme from this terminal palette.

Trait Implementations§

Source§

impl Clone for ThemePreset

Source§

fn clone(&self) -> ThemePreset

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 ThemePreset

Source§

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

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

impl Display for ThemePreset

Source§

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

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

impl Hash for ThemePreset

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ThemePreset

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for ThemePreset

Source§

impl Eq for ThemePreset

Source§

impl StructuralPartialEq for ThemePreset

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.