Struct ResolvedTheme

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

A Theme where all internal links have been resolved.

Instead of ThemeValues, a ResolvedTheme has Styles as values. These cannot link to other entries of the theme but completely define a style on their own.

A ResolvedTheme can be created from a Theme with Theme::resolve_links or the TryFrom<Theme> implementation.

To get the style for a key in this theme, the preferred method is using ResolvedTheme::find_style, which will return the best match it finds. See the method’s docs for more information. Alternatively, ResolvedTheme::get can be used to only look for an exact match.

Implementations

impl ResolvedTheme

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

Create a new ResolvedTheme from a map of theme keys to Styles.

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

Consume self and return the contained theme map.

May be used to merge multiple ResolvedThemes together.

pub fn get<Q>(&self, key: &Q) -> Option<&Style>

where String: Borrow<Q>, Q: Ord + ?Sized,

Returns a reference to the style corresponding to the key.

pub fn find_style(&self, key: &str) -> Option<Style>

Try to find the best possible style supported by the them given a theme key.

For example, if key is keyword.operator but this theme only has a style defined for keyword, then the style for keyword is returned. Additionally, if no style is found, the method tries to use the keys text and text.literal as fallbacks.

Trait Implementations

impl Clone for ResolvedTheme

fn clone(&self) -> ResolvedTheme

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResolvedTheme

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

Formats the value using the given formatter.

impl From<BTreeMap<String, Style>> for ResolvedTheme

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

Converts to this type from the input type.

impl Hash for ResolvedTheme

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<Q> Index<&Q> for ResolvedTheme

where String: Borrow<Q>, Q: Ord + ?Sized,

type Output = Style

The returned type after indexing.

fn index(&self, key: &Q) -> &Self::Output

Performs the indexing (container[index]) operation.

impl PartialEq for ResolvedTheme

fn eq(&self, other: &ResolvedTheme) -> 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 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 ResolvedTheme

impl StructuralPartialEq for ResolvedTheme