Struct Theme

pub struct Theme(/* private fields */);

A raw theme which may contain links to other items inside.

Internally, this type stores a map from Strings to ThemeValues. This map can be retrieved using Theme::into_inner. The map keys do not all have to be in THEME_KEYS; other custom keys can be used, for example to define a set of colors and reuse them with links everywhere else.

When using the serde feature, this type implements serde’s Serialize and Deserialize traits.

Instantiation

The easiest way to create a Theme is with the theme! macro. Alternatively, a Theme may be created from a BTreeMap<String, ThemeValue> using Theme::new.

Implementations

impl Theme

pub fn new(highlights: BTreeMap<String, ThemeValue>) -> Self

Create a new Theme from a map of theme keys to ThemeValues.

pub fn into_inner(self) -> BTreeMap<String, ThemeValue>

Consume self and return the contained theme map.

May be used to merge multiple Themes together.

pub fn resolve_links(self) -> Result<ResolvedTheme>

Try to resolve all links in this Theme and return a ResolvedTheme.

Errors

The function may return the following errors:

• Error::InvalidHex if a color string was an invalid hexadecimal literal.
• Error::InvalidLink if a link points to a non-existent key.

Trait Implementations

impl Clone for Theme

fn clone(&self) -> Theme

Returns a copy 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<'de> Deserialize<'de> for Theme

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BTreeMap<String, ThemeValue>> for Theme

fn from(highlights: BTreeMap<String, ThemeValue>) -> Self

Converts to this type from the input type.

impl Hash for Theme

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Theme

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Theme

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Theme> for ResolvedTheme

fn try_from(value: Theme) -> Result<Self>

Try to create a ResolvedTheme from a Theme by calling Theme::resolve_links.

type Error = Error

The type returned in the event of a conversion error.

impl Eq for Theme

impl StructuralPartialEq for Theme