Skip to main content

ReviewTheme

Struct ReviewTheme 

Source
pub struct ReviewTheme {
    pub diff: DiffPalette,
    pub ui: UiPalette,
    pub syntax: SyntaxTheme,
    pub markdown: MarkdownPalette,
    /* private fields */
}

Fields§

§diff: DiffPalette§ui: UiPalette§syntax: SyntaxTheme§markdown: MarkdownPalette

Implementations§

Source§

impl ReviewTheme

Source

pub fn builder(id: impl Into<String>) -> ReviewThemeBuilder

Source

pub fn from_bytes(id: ThemeId, bytes: &[u8]) -> Result<Self, ThemeError>

Parses a versioned Diff theme JSON document.

Capture lookup first tries an exact name and then progressively removes dot-separated suffixes. The full parsed palette and map affect revision.

§Errors

Returns an error for malformed JSON or an unsupported schema version.

Source

pub const fn id(&self) -> &ThemeId

Source

pub fn revision(&self) -> Fingerprint

Source

pub fn to_bytes(&self) -> Result<Vec<u8>, ThemeError>

Source

pub fn catalog() -> Vec<ThemeDescriptor>

Returns all selectable built-in themes, with stable kebab-case identifiers.

Examples found in repository?
examples/theme_gallery.rs (line 9)
5fn main() -> Result<(), ThemeError> {
6    println!(
7        "<!doctype html><meta charset=\"utf-8\"><title>Clankerdiff UI palette gallery</title><style>body{{margin:0;background:#888;font:14px monospace;display:grid;grid-template-columns:repeat(auto-fit,minmax(390px,1fr))}}section{{padding:24px}}p{{padding:8px}}button{{border:0;padding:8px;margin:4px;font:inherit}}h2{{font-size:18px}}</style>"
8    );
9    for descriptor in ReviewTheme::catalog() {
10        let ui = ReviewTheme::builtin(&descriptor.id)?.ui;
11        println!(
12            "<section style=\"background:{};color:{}\"><h2>{}</h2>",
13            css(ui.canvas),
14            css(ui.text),
15            descriptor.name
16        );
17        for (label, foreground) in [
18            ("Primary content", ui.text),
19            ("Secondary metadata", ui.text_secondary),
20            ("Muted hints / disabled", ui.text_muted),
21            ("Info: running tool", ui.info),
22            ("Positive: completed", ui.positive),
23            ("Warning: context pressure", ui.warning),
24            ("Destructive: failed", ui.destructive),
25        ] {
26            println!("<p style=\"color:{}\">{label}</p>", css(foreground));
27        }
28        println!(
29            "<p style=\"background:{};border:1px solid {}\">Ordinary input / message surface</p>",
30            css(ui.surface),
31            css(ui.border)
32        );
33        println!(
34            "<p style=\"background:{}\">Hovered surface</p>",
35            css(ui.surface_hover)
36        );
37        for state in [SelectionState::Selected, SelectionState::Focused] {
38            let style = ui.selection_style(state);
39            println!(
40                "<p style=\"background:{};color:{}\">{state:?} row</p>",
41                css(style.background.unwrap_or(ui.canvas)),
42                css(style.foreground)
43            );
44        }
45        for variant in [
46            ButtonVariant::Primary,
47            ButtonVariant::Secondary,
48            ButtonVariant::Destructive,
49        ] {
50            let style = ui.control_style(variant, ControlState::new(InteractionState::Rest));
51            println!(
52                "<button style=\"background:{};color:{}\">{variant:?}</button>",
53                css(style.background.unwrap_or(ui.canvas)),
54                css(style.foreground)
55            );
56        }
57        println!("</section>");
58    }
59    Ok(())
60}
Source

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

Loads a selectable built-in theme by its stable identifier.

Aliases are matched case-insensitively and with spaces or underscores normalized to dashes.

§Errors

Returns an error when no built-in theme has the supplied identifier.

Examples found in repository?
examples/theme_gallery.rs (line 10)
5fn main() -> Result<(), ThemeError> {
6    println!(
7        "<!doctype html><meta charset=\"utf-8\"><title>Clankerdiff UI palette gallery</title><style>body{{margin:0;background:#888;font:14px monospace;display:grid;grid-template-columns:repeat(auto-fit,minmax(390px,1fr))}}section{{padding:24px}}p{{padding:8px}}button{{border:0;padding:8px;margin:4px;font:inherit}}h2{{font-size:18px}}</style>"
8    );
9    for descriptor in ReviewTheme::catalog() {
10        let ui = ReviewTheme::builtin(&descriptor.id)?.ui;
11        println!(
12            "<section style=\"background:{};color:{}\"><h2>{}</h2>",
13            css(ui.canvas),
14            css(ui.text),
15            descriptor.name
16        );
17        for (label, foreground) in [
18            ("Primary content", ui.text),
19            ("Secondary metadata", ui.text_secondary),
20            ("Muted hints / disabled", ui.text_muted),
21            ("Info: running tool", ui.info),
22            ("Positive: completed", ui.positive),
23            ("Warning: context pressure", ui.warning),
24            ("Destructive: failed", ui.destructive),
25        ] {
26            println!("<p style=\"color:{}\">{label}</p>", css(foreground));
27        }
28        println!(
29            "<p style=\"background:{};border:1px solid {}\">Ordinary input / message surface</p>",
30            css(ui.surface),
31            css(ui.border)
32        );
33        println!(
34            "<p style=\"background:{}\">Hovered surface</p>",
35            css(ui.surface_hover)
36        );
37        for state in [SelectionState::Selected, SelectionState::Focused] {
38            let style = ui.selection_style(state);
39            println!(
40                "<p style=\"background:{};color:{}\">{state:?} row</p>",
41                css(style.background.unwrap_or(ui.canvas)),
42                css(style.foreground)
43            );
44        }
45        for variant in [
46            ButtonVariant::Primary,
47            ButtonVariant::Secondary,
48            ButtonVariant::Destructive,
49        ] {
50            let style = ui.control_style(variant, ControlState::new(InteractionState::Rest));
51            println!(
52                "<button style=\"background:{};color:{}\">{variant:?}</button>",
53                css(style.background.unwrap_or(ui.canvas)),
54                css(style.foreground)
55            );
56        }
57        println!("</section>");
58    }
59    Ok(())
60}
Source

pub fn sage() -> Result<Self, ThemeError>

Loads the bundled Sage theme.

§Errors

Returns an error if the checked-in theme JSON is invalid.

Source

pub fn ayu() -> Result<Self, ThemeError>

Loads the bundled Ayu Dark theme.

§Errors

Returns an error if the checked-in theme JSON is invalid.

Trait Implementations§

Source§

impl Clone for ReviewTheme

Source§

fn clone(&self) -> ReviewTheme

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 ReviewTheme

Source§

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

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

impl Default for ReviewTheme

Source§

fn default() -> Self

Returns the “default value” for a type. 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.