Struct syntect::easy::HighlightLines

pub struct HighlightLines<'a> { /* private fields */ }

Simple way to go directly from lines of text to colored tokens.

Depending on how you load the syntaxes (see the SyntaxSet docs), this can either take strings with trailing \ns or without.

Examples

Prints colored lines of a string to the terminal

use syntect::easy::HighlightLines;
use syntect::parsing::SyntaxSet;
use syntect::highlighting::{ThemeSet, Style};
use syntect::util::{as_24_bit_terminal_escaped, LinesWithEndings};

// Load these once at the start of your program
let ps = SyntaxSet::load_defaults_newlines();
let ts = ThemeSet::load_defaults();

let syntax = ps.find_syntax_by_extension("rs").unwrap();
let mut h = HighlightLines::new(syntax, &ts.themes["base16-ocean.dark"]);
let s = "pub struct Wow { hi: u64 }\nfn blah() -> u64 {}";
for line in LinesWithEndings::from(s) { // LinesWithEndings enables use of newlines mode
    let ranges: Vec<(Style, &str)> = h.highlight_line(line, &ps).unwrap();
    let escaped = as_24_bit_terminal_escaped(&ranges[..], true);
    print!("{}", escaped);
}

Implementations

impl<'a> HighlightLines<'a>

pub fn new(syntax: &SyntaxReference, theme: &'a Theme) -> HighlightLines<'a>

pub fn highlight<'b>(
    &mut self,
    line: &'b str,
    syntax_set: &SyntaxSet
) -> Vec<(Style, &'b str)>

👎 Deprecated since 5.0.0:

Renamed to highlight_line to make it clear it should be passed a single line at a time

pub fn highlight_line<'b>(
    &mut self,
    line: &'b str,
    syntax_set: &SyntaxSet
) -> Result<Vec<(Style, &'b str)>, Error>

Highlights a line of a file