Struct syntect::parsing::syntax_definition::SyntaxDefinition

pub struct SyntaxDefinition {
    pub name: String,
    pub file_extensions: Vec<String>,
    pub scope: Scope,
    pub first_line_match: Option<String>,
    pub hidden: bool,
    pub variables: HashMap<String, String>,
    pub contexts: HashMap<String, Context>,
}

The main data structure representing a syntax definition loaded from a .sublime-syntax file. You'll probably only need these as references to be passed around to parsing code.

Some useful public fields are the name field which is a human readable name to display in syntax lists, and the hidden field which means hide this syntax from any lists because it is for internal use.

Fields

name: String

file_extensions: Vec<String>

scope: Scope

first_line_match: Option<String>

hidden: bool

variables: HashMap<String, String>

contexts: HashMap<String, Context>

Implementations

impl SyntaxDefinition

pub fn load_from_str(
    s: &str,
    lines_include_newline: bool,
    fallback_name: Option<&str>
) -> Result<SyntaxDefinition, ParseSyntaxError>

In case you want to create your own SyntaxDefinition's in memory from strings. Generally you should use a SyntaxSet

fallback_name is an optional name to use when the YAML doesn't provide a name key.

Trait Implementations

impl Clone for SyntaxDefinition

fn clone(&self) -> SyntaxDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SyntaxDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SyntaxDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for SyntaxDefinition

impl PartialEq<SyntaxDefinition> for SyntaxDefinition

fn eq(&self, other: &SyntaxDefinition) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SyntaxDefinition) -> bool

This method tests for !=.

impl Serialize for SyntaxDefinition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for SyntaxDefinition

impl StructuralPartialEq for SyntaxDefinition