Struct HighlightResource

pub struct HighlightResource<'theme> { /* private fields */ }

Highlight Resource

Create new instance

use hlight::HighlightResource;
use hlight::theme::names::monokai;

let res = HighlightResource::default();
assert_eq!(res.get_theme_name(), monokai());

Enable or disable background

use hlight::HighlightResource;

let res = HighlightResource::default().with_background(false);
assert!(!res.get_background())

Implementations

impl<'theme> HighlightResource<'theme>

pub fn get_theme_name(&self) -> &CompactString

pub fn get_theme_set(&self) -> &&'theme ThemeSet

pub fn get_syntax_set(&self) -> &&'theme SyntaxSet

pub fn get_background(&self) -> &bool

impl<'theme> HighlightResource<'theme>

pub fn with_theme_name(self, val: CompactString) -> HighlightResource<'theme>

pub fn with_theme( self, val: OnceLock<&'theme Theme>, ) -> HighlightResource<'theme>

• get or init: Self::get_or_init_theme

pub fn with_theme_set(self, val: &'theme ThemeSet) -> HighlightResource<'theme>

pub fn with_syntax_set( self, val: &'theme SyntaxSet, ) -> HighlightResource<'theme>

pub fn with_background(self, val: bool) -> HighlightResource<'theme>

impl<'a> HighlightResource<'a>

pub fn new<S>(name: S, theme_set: &'a ThemeSet) -> HighlightResource<'a>

where S: Into<CompactString>,

Creates a new instance of HighlightResource

Example

use hlight::HighlightResource;

let set = HighlightResource::static_theme_set();
let res = HighlightResource::new("ayu-dark", &set);

impl HighlightResource<'_>

pub fn static_syntax_set() -> &'static SyntaxSet

This is the default syntax set.

Example

use hlight::HighlightResource;

let set = HighlightResource::static_syntax_set();

set.syntaxes()
    .iter()
    .map(|x| (&x.name, &x.file_extensions))
    .for_each(|(name, ext)| {
        println!(
        "name: {name}\n\
        ext:{ext:?}\n---"
        )
    });

impl HighlightResource<'_>

pub fn get_or_init_theme(&self) -> &Theme

Gets the theme or initialize it if it is not already set.

pub fn static_theme_set() -> &'static ThemeSet

This is the default theme set.

Example

use hlight::HighlightResource;

let set = HighlightResource::static_theme_set();
let themes = &set.themes;

for t in themes.keys() {
    println!("{t}")
}

Trait Implementations

impl<'theme> Clone for HighlightResource<'theme>

fn clone(&self) -> HighlightResource<'theme>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'theme> Debug for HighlightResource<'theme>

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

Formats the value using the given formatter.

impl Default for HighlightResource<'_>

fn default() -> HighlightResource<'_>

Returns the “default value” for a type.