Struct Syntax 

pub struct Syntax { /* private fields */ }

The rules of one language, ready to scan text with.

Implementations

impl Syntax

pub fn load(path: &Path) -> Result<Self, Error>

Reads a language file.

Errors

Returns Error::Read if the file cannot be opened or holds a duplicate key, and Error::Rule if a rule lacks the words it needs — block_comment without both delimiters, or strings without one.

pub fn parse(text: &str) -> Result<Self, Error>

Parses a language definition from text, the same format load reads from a file.

Errors

Returns Error::Read if the text holds a duplicate key, and Error::Rule if a rule lacks the words it needs.

pub fn covers(&self, extension: &str) -> bool

Whether this language claims files ending in extension.

pub fn covers_language(&self, name: &str) -> bool

Whether this language answers to name, the way a markdown fence names one. Both the names line and the extensions count, so ```rust and ```rs find the same language.

pub fn spans(&self, text: &str) -> Vec<(Range<usize>, Class)>

Scans text and reports every span that carries a Class.

The ranges are byte offsets into text, in order and without overlap. Whatever is not covered has no class and stays unstyled.