Enum dialect::HighlightGroup

pub enum HighlightGroup {
    CtrlFlowKeyword,
    OtherKeyword,
    FunctionDef,
    FunctionCall,
    TyDef,
    TyUse,
    InterfaceDef,
    InterfaceUse,
    PrimitiveTy,
    VariableDef,
    VariableUse,
    MemberDef,
    MemberUse,
    ConstantDef,
    ConstantUse,
    ModuleDef,
    ModuleUse,
    MacroDef,
    MacroUse,
    SpecialIdentDef,
    SpecialIdentUse,
    FunctionParam,
    Number,
    String,
    StringDelimiter,
    Character,
    CharacterDelimiter,
    Boolean,
    PreProc,
    Attribute,
    Comment,
    DocComment,
    MemberOper,
    PointerOper,
    AssignOper,
    BinaryOper,
    OtherOper,
    Delimiter,
    Separator,
    Terminator,
    Error,
}

The set of possible syntactical forms text can be assigned.

Variants

CtrlFlowKeyword

a keyword that controls the flow of execution within code, e.g. if or for

OtherKeyword

any other kind of keyword

FunctionDef

the name of a function when defined

FunctionCall

the name of a function when called

TyDef

the name of a type when defined

TyUse

the name of a type when used

InterfaceDef

the name of an interface/trait/typeclass when defined

InterfaceUse

the name of an interface/trait/typeclass when used

PrimitiveTy

a ‘primitive’ baked into the language (e.g. int is a primitive type in C++, but std::vector isn’t)

VariableDef

the name of a variable when defined

VariableUse

the name of a variable when used

MemberDef

the name of a struct/class member when defined

MemberUse

the name of a struct/class member when used

ConstantDef

the name of a constant ‘variable’ when defined

ConstantUse

the name of a constant ‘variable’ when used

ModuleDef

the name of a module when defined

ModuleUse

the name of a module when used

MacroDef

the name of a macro when defined

MacroUse

the name of a macro when used

SpecialIdentDef

the name of a special identifier (e.g. a symbol in Ruby or a lifetime in Rust) when defined

SpecialIdentUse

the name of a special identifier when used

FunctionParam

the name of a function parameter

Number

a number literal (whether integer or floating-point)

String

a string literal

StringDelimiter

the delimiters around a string literal (" in most languages)

Character

a character literal

CharacterDelimiter

the delimiters around a character literal (' in most languages)

Boolean

a boolean literal (only to be used if it is a keyword in the language -- if boolean values are ‘just’ normal types like in Python and Haskell, then the TyUse variant is more appropriate)

PreProc

a pre-processor invocation that is not a macro itself (e.g. #if and #define in C)

Attribute

the name of something that is an attribute of another thing (e.g. the word derive in #[derive(Debug)] in Rust, or a decorator in Python)

Comment

a comment

DocComment

a documentation comment

MemberOper

an operator that accesses the members of something, regardless of whether this is some kind of ‘object’ or a module, e.g. . and :: in Rust

PointerOper

an operator relating to pointers (e.g. * and & in C, those as well as &mut in Rust)

AssignOper

an operator that assigns a value to a binding of some sort (= and += are examples)

BinaryOper

an operator that has two operands (e.g. +, ||)

OtherOper

any operator not covered by the other variants

Delimiter

a delimiter (e.g. ()

Separator

a separator of something (e.g. , or ->)

Terminator

a terminator of something (e.g. ;)

Error

an error

Trait Implementations

impl Clone for HighlightGroup

fn clone(&self) -> HighlightGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for HighlightGroup

impl Debug for HighlightGroup

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

Formats the value using the given formatter.

impl Eq for HighlightGroup

impl Hash for HighlightGroup

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl IntoEnumIterator for HighlightGroup

type Iterator = HighlightGroupIter

fn iter() -> HighlightGroupIter

impl Ord for HighlightGroup

fn cmp(&self, other: &HighlightGroup) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<HighlightGroup> for HighlightGroup

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<HighlightGroup> for HighlightGroup

fn partial_cmp(&self, other: &HighlightGroup) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for HighlightGroup

impl StructuralPartialEq for HighlightGroup