Skip to main content

Theme

Struct Theme 

Source
pub struct Theme { /* private fields */ }
Expand description

A named collection of styles. Mirrors rich.theme.Theme.

Implementations§

Source§

impl Theme

Source

pub fn new() -> Self

Source

pub fn get(&self, name: &str) -> Option<&Style>

Look up a style by name.

Source

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

Insert or replace a named style.

Source

pub fn get_style(&self, style: &StyleType) -> Result<Style>

Resolve a StyleType against this theme. Port of Console.get_style.

An already-resolved style passes straight through. A name is looked up in the theme first, and only then parsed as a style definition — the order matters, because the default theme itself defines bare words like none, bold and red, and a custom theme has to be able to shadow them.

The lookup is case-sensitive while the parse fallback is not, which reproduces an asymmetry upstream really has: "BOLD" misses the theme but still parses to bold, whereas a theme key "Danger" is never found by a span naming "danger".

Source

pub fn get_style_or_null(&self, style: &StyleType) -> Style

As get_style, but an unresolvable name yields the null style instead of an error. Port of upstream’s get_style(..., default=Style.null()), which is what the render path uses — an unknown name must not blow up a print.

Source

pub fn len(&self) -> usize

How many named styles this theme holds.

Source

pub fn is_empty(&self) -> bool

Whether this theme holds no styles.

Source

pub fn default_theme() -> Self

The complete upstream default theme — every entry of DEFAULT_STYLES.

Source

pub fn default_shared() -> &'static Theme

The shared default theme, for callers that only need to resolve a name (e.g. the built-in highlighters) and have no Console to hand.

Trait Implementations§

Source§

impl Clone for Theme

Source§

fn clone(&self) -> Theme

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 Theme

Source§

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

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

impl Default for Theme

Source§

fn default() -> Theme

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Theme

§

impl RefUnwindSafe for Theme

§

impl Send for Theme

§

impl Sync for Theme

§

impl Unpin for Theme

§

impl UnsafeUnpin for Theme

§

impl UnwindSafe for Theme

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.