Struct QueryFilter 

pub struct QueryFilter {

    pub language: Option<Language>,
    pub kind: Option<SymbolKind>,
    pub use_ast: bool,
    pub use_regex: bool,
    pub limit: Option<usize>,
    pub symbols_mode: bool,
    pub expand: bool,
    pub file_pattern: Option<String>,
    pub exact: bool,
    pub use_contains: bool,
    pub ignore_case: bool,
    pub exclude_text: bool,
    pub include_locks: bool,
    pub include_generated: bool,
    pub count_only: bool,
    pub timeout_secs: u64,
    pub glob_patterns: Vec<String>,
    pub exclude_patterns: Vec<String>,
    pub paths_only: bool,
    pub offset: Option<usize>,
    pub force: bool,
    pub suppress_output: bool,
    pub include_dependencies: bool,
    pub context_lines: usize,
    pub collect_timings: bool,
    pub require_exact_total: bool,
    /* private fields */
}

Query filter options

Fields

language: Option<Language>

Language filter (None = all languages)

kind: Option<SymbolKind>

Symbol kind filter (None = all kinds)

use_ast: bool

Use AST pattern matching (vs lexical search)

use_regex: bool

Use regex pattern matching

limit: Option<usize>

Maximum number of results

symbols_mode: bool

Search symbol definitions only (vs full-text)

expand: bool

Show full symbol body (from span.start_line to span.end_line)

file_pattern: Option<String>

File path filter (substring match)

exact: bool

Exact symbol name match (no substring matching)

use_contains: bool

Use substring matching instead of word-boundary matching (opt-in, expansive)

ignore_case: bool

Match letters regardless of case (rg -i). Applies to whole-identifier, substring and regex line searches alike; the engine runs the query as a (?i) regex whose literals are looked up under every case variant.

exclude_text: bool

Drop plain-text-tier results (docs, config, templates) from this query.

The tier is included by default, because an agent searching for a config key wants the YAML as well as the struct. It is excluded for questions that are only meaningful about code — find_references in particular, whose reference search is a plain trigram scan and would otherwise return the name in a changelog entry as a “call site”.

include_locks: bool

Search lock files too (Cargo.lock, package-lock.json, …). They are indexed but left out of every search by default; lang: "lock" selects them alone.

include_generated: bool

Search generated files too (*.pb.go, *.min.js, *.map, …). Same default as lock files; lang: "generated" selects them alone.

count_only: bool

Count matches without materialising them: no previews, no grouping, no result rows. total_count / pagination.total carry the exact line count and QueryResponse.file_count the files with a match. Honoured only by the full-text line searches (trigram and regex) with no limit; symbol and AST searches ignore it. Set by --count, mode: "count" and count_occurrences.

timeout_secs: u64

Query timeout in seconds (0 = no timeout)

glob_patterns: Vec<String>

Glob patterns to include (empty = all files)

exclude_patterns: Vec<String>

Glob patterns to exclude (applied after includes)

paths_only: bool

Return only unique file paths (deduplicated)

offset: Option<usize>

Pagination offset (skip first N results after sorting)

force: bool

Force execution of potentially expensive queries (bypass broad query detection)

suppress_output: bool

Suppress warning/info output (for –json mode to ensure pure JSON output)

include_dependencies: bool

Include dependency information in results

context_lines: usize

Number of context lines to show before and after each match (default: 0 = disabled)

collect_timings: bool

Record per-phase timings into QueryResponse.timings.

require_exact_total: bool

Verify every candidate even with a limit, so pagination.total is exact. Set by callers whose contract promises an exact total for a page (find_references). Without it, a list-mode search stops once the page is full and reports total_is_exact: false.

Implementations

impl QueryFilter

pub fn count_only_line_search(&self) -> bool

Whether this query is a count-only full-text LINE search: the one shape the verifier can answer with two numbers instead of result rows.

Trait Implementations

impl Clone for QueryFilter

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryFilter

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

Formats the value using the given formatter.

impl Default for QueryFilter

fn default() -> Self

Returns the “default value” for a type.