Struct Highlighter 

pub struct Highlighter { /* private fields */ }

A syntax highlighter that produces styled Text output. The output style can be changed using the configuration methods provided in this struct.

Implementations

impl Highlighter

pub fn new(theme: Theme) -> Self

Creates a new Highlighter with the given Theme.

Examples found in repository

examples/highlight_file.rs (line 25)

fn main() -> Result<()> {
    let mut terminal = setup_terminal()?;
    let theme = ASSETS.with(|a| a.get_theme("Nord").clone());
    let highlighter = Highlighter::new(theme);
    let syntaxes = ASSETS.with(|a| a.get_syntax_set().cloned())?;
    let syntax = syntaxes
        .find_syntax_by_name("Rust")
        .expect("syntax missing");
    let highlighted_text = highlighter.highlight_reader(
        File::open("./examples/sqlite_custom/build.rs")?,
        syntax,
        &syntaxes,
    )?;
    terminal.draw(|frame| {
        frame.render_widget(highlighted_text, frame.area());
    })?;
    read()?;
    restore_terminal(terminal)?;
    Ok(())
}

examples/background_color.rs (line 28)

fn main() -> Result<()> {
    let mut terminal = setup_terminal()?;
    let theme = ASSETS.with(|a| a.get_theme("Nord").clone());
    let highlighter = Highlighter::new(theme);
    let syntaxes = ASSETS.with(|a| a.get_syntax_set().cloned())?;
    let syntax = syntaxes
        .find_syntax_by_name("Rust")
        .expect("syntax missing");
    let highlight = highlighter.highlight_reader(
        File::open("./examples/sqlite_custom/build.rs")?,
        syntax,
        &syntaxes,
    )?;

    let bg = highlighter.get_background_color().unwrap_or_default();
    // Set the background on the text container so it matches.
    let paragraph = Paragraph::new(highlight).bg(bg).block(
        Block::bordered()
            .border_type(BorderType::Rounded)
            .padding(Padding::uniform(0))
            .title("Syntax Highlight!")
            .title_alignment(Alignment::Center),
    );
    terminal.draw(|frame| {
        frame.render_widget(paragraph, frame.area());
    })?;
    read()?;
    restore_terminal(terminal)?;
    Ok(())
}

pub fn override_background<C>(self, background: C) -> Self

where C: Into<Color>,

Override the background with a different color. Set this to Color::Reset to disable the background color.

pub fn line_numbers(self, line_numbers: bool) -> Self

Enable or disable line numbers in the left gutter.

pub fn line_number_padding(self, padding: usize) -> Self

Set the padding between the line number section and the rest of the code.

pub fn line_number_style<S>(self, style: S) -> Self

where S: Into<Style>,

Set the Style for the line number section.

pub fn line_number_separator_style<S>(self, style: S) -> Self

where S: Into<Style>,

Set the Style for the separator between the line number section and the rest of the code.

pub fn line_number_separator<T>(self, separator: T) -> Self

where T: Into<String>,

Set the text used for the line number separator. | is used by default.

pub fn highlight_range(self, range: Range<usize>) -> Self

Highlight a specific range of code with a different style.

pub fn highlight_style(self, style: Style) -> Self

Set the style used for highlight_range. A yellow background is used by default.

pub fn gutter_template<F>(self, template: F) -> Self

where F: Fn(usize, Style) -> Vec<Span<'static>> + Send + Sync + 'static,

Set a template function to configure the gutter section. This is an alternative to using line_number_style, line_number_separator_style, and line_number_padding if you need more flexibility.

pub fn get_background_color(&self) -> Option<Color>

Returns the configured background color, accounting for both the theme and any overrides. This is useful if you want to render the code block into a larger section and you need the background colors to match.

Examples found in repository

examples/background_color.rs (line 39)

fn main() -> Result<()> {
    let mut terminal = setup_terminal()?;
    let theme = ASSETS.with(|a| a.get_theme("Nord").clone());
    let highlighter = Highlighter::new(theme);
    let syntaxes = ASSETS.with(|a| a.get_syntax_set().cloned())?;
    let syntax = syntaxes
        .find_syntax_by_name("Rust")
        .expect("syntax missing");
    let highlight = highlighter.highlight_reader(
        File::open("./examples/sqlite_custom/build.rs")?,
        syntax,
        &syntaxes,
    )?;

    let bg = highlighter.get_background_color().unwrap_or_default();
    // Set the background on the text container so it matches.
    let paragraph = Paragraph::new(highlight).bg(bg).block(
        Block::bordered()
            .border_type(BorderType::Rounded)
            .padding(Padding::uniform(0))
            .title("Syntax Highlight!")
            .title_alignment(Alignment::Center),
    );
    terminal.draw(|frame| {
        frame.render_widget(paragraph, frame.area());
    })?;
    read()?;
    restore_terminal(terminal)?;
    Ok(())
}

pub fn get_line_number_style(&self) -> Style

Returns the configured line number style, accounting for both the theme and any overrides.

pub fn highlight_reader<R>( &self, reader: R, syntax: &SyntaxReference, syntaxes: &SyntaxSet, ) -> Result<Text<'static>, Error>

where R: Read,

Highlights text from any io::Read source.

Examples found in repository

examples/highlight_file.rs (lines 30-34)

fn main() -> Result<()> {
    let mut terminal = setup_terminal()?;
    let theme = ASSETS.with(|a| a.get_theme("Nord").clone());
    let highlighter = Highlighter::new(theme);
    let syntaxes = ASSETS.with(|a| a.get_syntax_set().cloned())?;
    let syntax = syntaxes
        .find_syntax_by_name("Rust")
        .expect("syntax missing");
    let highlighted_text = highlighter.highlight_reader(
        File::open("./examples/sqlite_custom/build.rs")?,
        syntax,
        &syntaxes,
    )?;
    terminal.draw(|frame| {
        frame.render_widget(highlighted_text, frame.area());
    })?;
    read()?;
    restore_terminal(terminal)?;
    Ok(())
}

examples/background_color.rs (lines 33-37)

fn main() -> Result<()> {
    let mut terminal = setup_terminal()?;
    let theme = ASSETS.with(|a| a.get_theme("Nord").clone());
    let highlighter = Highlighter::new(theme);
    let syntaxes = ASSETS.with(|a| a.get_syntax_set().cloned())?;
    let syntax = syntaxes
        .find_syntax_by_name("Rust")
        .expect("syntax missing");
    let highlight = highlighter.highlight_reader(
        File::open("./examples/sqlite_custom/build.rs")?,
        syntax,
        &syntaxes,
    )?;

    let bg = highlighter.get_background_color().unwrap_or_default();
    // Set the background on the text container so it matches.
    let paragraph = Paragraph::new(highlight).bg(bg).block(
        Block::bordered()
            .border_type(BorderType::Rounded)
            .padding(Padding::uniform(0))
            .title("Syntax Highlight!")
            .title_alignment(Alignment::Center),
    );
    terminal.draw(|frame| {
        frame.render_widget(paragraph, frame.area());
    })?;
    read()?;
    restore_terminal(terminal)?;
    Ok(())
}

pub fn highlight_lines<'a, T>( &self, source: T, syntax: &SyntaxReference, syntaxes: &SyntaxSet, ) -> Result<Text<'static>, Error>

where T: IntoIterator<Item = &'a str>,

Highlights text from an iterator.

pub fn highlight_line( &self, line: &str, highlighter: &mut HighlightLines<'_>, line_number: usize, line_number_style: Style, syntaxes: &SyntaxSet, ) -> Result<Line<'static>, Error>

Highlights a single line.

Trait Implementations

impl Clone for Highlighter

fn clone(&self) -> Highlighter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Highlighter

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

Formats the value using the given formatter.