Struct syntect::parsing::syntax_definition::SyntaxDefinition
source · 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>,
}
Expand description
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>
§variables: HashMap<String, String>
§contexts: HashMap<String, Context>
Implementations§
source§impl SyntaxDefinition
impl SyntaxDefinition
sourcepub fn load_from_str(
s: &str,
lines_include_newline: bool,
fallback_name: Option<&str>
) -> Result<SyntaxDefinition, ParseSyntaxError>
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§
source§impl Clone for SyntaxDefinition
impl Clone for SyntaxDefinition
source§fn clone(&self) -> SyntaxDefinition
fn clone(&self) -> SyntaxDefinition
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for SyntaxDefinition
impl Debug for SyntaxDefinition
source§impl<'de> Deserialize<'de> for SyntaxDefinition
impl<'de> Deserialize<'de> for SyntaxDefinition
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl PartialEq for SyntaxDefinition
impl PartialEq for SyntaxDefinition
source§fn eq(&self, other: &SyntaxDefinition) -> bool
fn eq(&self, other: &SyntaxDefinition) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl Serialize for SyntaxDefinition
impl Serialize for SyntaxDefinition
impl Eq for SyntaxDefinition
impl StructuralPartialEq for SyntaxDefinition
Auto Trait Implementations§
impl RefUnwindSafe for SyntaxDefinition
impl Send for SyntaxDefinition
impl Sync for SyntaxDefinition
impl Unpin for SyntaxDefinition
impl UnwindSafe for SyntaxDefinition
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Checks if this value is equivalent to the given key. Read more
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.