Enum QueryConfig 

pub enum QueryConfig {
    TreeSitter(String),
    Structured {
        format: QueryFormat,
        query: String,
        strip: Option<String>,
        template: Option<String>,
    },
}

A named query — either a raw tree-sitter S-expression string, or a table with an explicit format and optional post-processing.

# Simple tree-sitter query (string form — no post-processing)
[preprocessor.treesitter.rust.queries]
struct = "(struct_item name: (type_identifier) @name) @struct"

# Tree-sitter query with a strip regex (table form, format defaults to treesitter)
[preprocessor.treesitter.rust.queries.comment_text]
query = "((line_comment)+ @doc_comment ...)"
strip = "^///? ?"

# jq query (table form with explicit format)
[preprocessor.treesitter.rust.queries.doc_comment_jq]
format = "jq"
query = ".children[] | select(.type == \"struct_item\") | ..."

Variants

TreeSitter(String)

A plain tree-sitter S-expression query string (no strip).

Structured

A structured query: format defaults to treesitter when omitted.

The optional strip field is a regex applied to every output line — matches are removed, which lets you strip comment delimiters, braces, leading whitespace, etc.

Fields

format: QueryFormat

query: String

strip: Option<String>

Regex whose matches are deleted from each output line.

template: Option<String>

Output template applied once per query match.

Use {capture_name} placeholders to interpolate captured text. When multiple nodes are captured under the same name (e.g. (line_comment)+), they are joined with \n before substitution. The strip regex, if present, is applied to each capture’s text before substitution.

[preprocessor.treesitter.rust.queries.enum_variants]
query = "((line_comment)+ @doc_comment . (enum_variant name: (identifier) @name))"
strip = "^///? ?"
template = "- {name}: {doc_comment}"

Implementations

impl QueryConfig

pub fn format(&self) -> QueryFormat

pub fn query_str(&self) -> &str

pub fn strip(&self) -> Option<&str>

Returns the strip regex, if any.

pub fn template(&self) -> Option<&str>

Returns the output template, if any.

Trait Implementations

impl Clone for QueryConfig

fn clone(&self) -> QueryConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QueryConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for QueryConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.