Struct QueryBuilder 

pub struct QueryBuilder<'d> { /* private fields */ }

A builder for configuring and executing dictionary lookups.

Implementations

impl<'d> QueryBuilder<'d>

pub fn mode(self, mode: MatchMode) -> Self

Set the match mode for this query.

pub fn common_only(self, common: bool) -> Self

Filter to entries where any KanjiEntry or KanaEntry has common: true.

pub fn pos(self, pos: &[&str]) -> Self

Filter to entries with matching part_of_speech values in any SenseEntry.

pub fn misc(self, misc: &[&str]) -> Self

Filter to entries with any of the given JMdict misc codes (e.g. "uk" for “usually written in kana”, "abbr" for abbreviation).

pub fn field(self, field: &[&str]) -> Self

Filter to entries with any of the given JMdict field codes (e.g. "med" for medicine, "comp" for computing).

pub fn dialect(self, dialect: &[&str]) -> Self

Filter to entries with any of the given JMdict dialect codes (e.g. "ksb" for Kansai-ben, "ktb" for Kantou-ben).

pub fn max_distance(self, n: u32) -> Self

Set the maximum edit distance for fuzzy search (default: 2).

Clamped to a maximum of MAX_FUZZY_DISTANCE to keep the Levenshtein DFA from blowing up — the automaton’s state space grows quickly with distance.

pub fn limit(self, limit: usize) -> Self

Cap results after filtering and sorting.

pub fn execute(self) -> Result<Vec<LookupResult>, JmdictError>

Execute the query and return all results collected into a Vec.

pub fn execute_iter(self) -> Result<LookupResultIter<'d>, JmdictError>

Execute the query and return a lazy iterator that deserializes entries on demand.

This is more memory-efficient than execute() for large result sets (e.g., prefix or fuzzy queries with many matches), as entries are only deserialized as consumed.