Struct SublimeSyntaxSet 

pub struct SublimeSyntaxSet { /* private fields */ }

A collection of compiled Sublime syntax definitions, with support for resolving extends and include.

Implementations

impl SublimeSyntaxSet

pub fn new() -> Self

Create an empty syntax set.

pub fn add_search_path(&mut self, path: impl Into<PathBuf>)

Adds a filesystem search path used to resolve Packages/... references.

pub fn get_by_scope(&self, scope: &str) -> Option<Arc<SublimeSyntax>>

Get a compiled syntax by its scope (e.g. "source.rust").

pub fn load_from_str( &mut self, yaml: &str, ) -> Result<Arc<SublimeSyntax>, SublimeSyntaxError>

Loads a syntax from a YAML string and returns the compiled result.

If the syntax uses extends: ..., it will be resolved via search_paths.

pub fn load_from_path( &mut self, path: impl AsRef<Path>, ) -> Result<Arc<SublimeSyntax>, SublimeSyntaxError>

Loads a syntax from a filesystem path and returns the compiled result.

pub fn load_by_reference( &mut self, reference: &str, ) -> Result<Arc<SublimeSyntax>, SublimeSyntaxError>

Loads (or returns a cached) compiled syntax by a Sublime reference string.

Supported forms:

• scope:source.rust (lookup by scope)
• Packages/JavaScript/JavaScript.sublime-syntax (filesystem search)
• absolute or relative filesystem paths

Trait Implementations

impl Debug for SublimeSyntaxSet

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

Formats the value using the given formatter.

impl Default for SublimeSyntaxSet

fn default() -> SublimeSyntaxSet

Returns the “default value” for a type.