REFERENCE · API

Rust API

Stable facade

The crate root exports Engine, Matcher, ResourceBundle, compile options, errors, and match-provenance types. These exports form the 1.x compatibility contract.

A matcher searches UTF-8 bytes and performs no file traversal, encoding detection, or output.

Matcher::find_all_with_diagnostics(input, &diagnostics) records unavailable structural verification in SearchDiagnostics::structural_verification_incomplete(). Create diagnostics per search scope. Reusing a scope accumulates its state; do not share it between workers.

Resource initialization

Engine::with_resources validates optional full-POS, enriched-predicate, and component data as one profile. Engine::new creates an embedded profile.

load_component_resource applies a replacement only after full validation and preserves the old resource on failure.

Expert API

kfind::expert exposes caller-configured Lexicons, QueryPlan, and matcher-plan access.

Expert types never appear in root facade parameters or return values and remain outside the 1.x stable contract.