Struct LanguageSpec 

#[non_exhaustive]
pub struct LanguageSpec {
    pub name: CompactString,
    pub language: Language,
    pub extensions: SmallVec<[CompactString; 4]>,
    pub tags_query: Option<Cow<'static, str>>,
    pub injections_query: Option<Cow<'static, str>>,
    pub merge_adjacent_same_name_definitions: bool,
    pub imports: Option<ImportSpec>,
}

Parsing and query metadata for one registered language.

Create specifications with LanguageSpec::new and its builder methods. The struct is non-exhaustive so hosts can keep registering custom grammars when Hearth adds optional language metadata.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: CompactString

Wire-stable lowercase language name.

language: Language

Tree-sitter grammar.

extensions: SmallVec<[CompactString; 4]>

File extensions recognized for this language, without leading dots.

tags_query: Option<Cow<'static, str>>

Tree-sitter tags query used for symbol extraction.

injections_query: Option<Cow<'static, str>>

Tree-sitter injection query used to find embedded source languages.

Injected language names resolve against other entries in the same registry. Their symbols and imports retain containing-file locations.

merge_adjacent_same_name_definitions: bool

Merge adjacent same-name definitions emitted for one logical symbol.

This is intended for grammars such as Haskell, where each equation of one function is represented by a separate definition node.

imports: Option<ImportSpec>

Import extraction strategy, when available.

Implementations

impl LanguageSpec

pub fn new<I, E>( name: impl Into<CompactString>, language: Language, extensions: I, ) -> Self

where I: IntoIterator<Item = E>, E: AsRef<str>,

Creates a language specification with no symbol or import queries.

Extensions must not include a leading dot. Optional behavior can be enabled with the builder methods without coupling hosts to every field.

pub fn with_tags_query(self, tags_query: impl Into<Cow<'static, str>>) -> Self

Configures the tree-sitter tags query used for symbol extraction.

pub fn with_injections_query( self, injections_query: impl Into<Cow<'static, str>>, ) -> Self

Configures the tree-sitter query used to locate embedded languages.

pub const fn with_merge_adjacent_same_name_definitions( self, enabled: bool, ) -> Self

Configures whether adjacent same-name definitions form one symbol.

pub fn with_imports(self, imports: ImportSpec) -> Self

Configures import extraction for the language.