Struct CodeTheme 

pub struct CodeTheme { /* private fields */ }

An owned syntax-highlighting theme for fenced code blocks.

Convert a BuiltinCodeTheme into this type, parse TextMate source with CodeTheme::from_textmate, or load a TextMate file with CodeTheme::from_file. Then pass the theme to Options::code_theme.

The renderer consults the theme only for fenced code blocks whose language is recognized.

This type hides the syntax-highlighting implementation so applications do not need to depend on its types or version.

Implementations

impl CodeTheme

pub fn from_textmate(source: &str) -> Result<Self, CodeThemeLoadError>

Parses a TextMate syntax-highlighting theme.

This constructor parses source immediately and does not access the filesystem. The returned theme owns the parsed data and does not borrow source. Applications can combine this method with include_str! to compile a theme into their binary.

Errors

Returns CodeThemeLoadError when source is not a valid TextMate theme.

pub fn from_file(path: impl AsRef<Path>) -> Result<Self, CodeThemeLoadError>

Loads a TextMate syntax-highlighting theme from disk.

This function reads and parses the file synchronously. The resulting CodeTheme owns the parsed theme, so rendering does not access the file again. Use CodeTheme::from_textmate with include_str! when the theme should be compiled into the application instead.

Errors

Returns CodeThemeLoadError when the file cannot be read or its contents are not a valid TextMate theme. The error message includes the requested path.

Example

use tui_markdown::{CodeTheme, Options};

let theme = CodeTheme::from_file("themes/solarized.tmTheme")?;
let options = Options::default().code_theme(theme);

Trait Implementations

impl Clone for CodeTheme

fn clone(&self) -> CodeTheme

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeTheme

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

Formats the value using the given formatter.

impl From<BuiltinCodeTheme> for CodeTheme

fn from(theme: BuiltinCodeTheme) -> Self

Converts to this type from the input type.