Struct Config 

pub struct Config {
    pub version: u64,
    pub languages: Vec<String>,
    pub imports: Vec<String>,
    pub rules: Vec<Rule>,
    pub scopes: Vec<Scope>,
    /* private fields */
}

A validated configuration: the schema version, global rules, and scopes.

Fields

version: u64

The config’s declared schema version (always SUPPORTED_VERSION).

languages: Vec<String>

The editor language ids this config applies to (exact match against the client’s languageId; in Neovim, the filetype). Empty = every language.

imports: Vec<String>

The raw import: entries, as written.

rules: Vec<Rule>

The validated global rules, in file order (imported rules first).

scopes: Vec<Scope>

The validated scopes, in file order (imported scopes first).

Implementations

impl Config

pub fn matches_language(&self, id: &str) -> bool

Whether this config applies to documents with language id id. Configs without a languages key apply to everything.

impl Config

pub fn from_str(yaml: &str) -> Result<Self, ConfigError>

Loads and validates a config from YAML text.

preset: imports resolve against the embedded library; relative file imports need a file — use Config::load for those.

pub fn load(path: impl AsRef<Path>) -> Result<Self, ConfigError>

Loads and validates the config site at path (a file), resolving its import: entries recursively.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.