Struct QueryBuilder

pub struct QueryBuilder { /* private fields */ }

A builder for constructing Anki search queries

This builder provides a fluent interface for creating properly escaped and formatted Anki search queries. It helps prevent syntax errors and ensures proper escaping of special characters.

Implementations

impl QueryBuilder

pub fn new() -> Self

Creates a new, empty query builder

pub fn text<S: AsRef<str>>(self, text: S) -> Self

Adds free text to search for across all fields

Special characters are automatically escaped.

pub fn field<S: AsRef<str>>(self, field_name: S) -> FieldQueryBuilder

Specifies a field to search in

This must be followed by one of the field content methods like contains.

pub fn in_field(self, field: &Field) -> FieldQueryBuilder

Specifies a field to search in using a Field reference

This must be followed by one of the field content methods like contains.

pub fn in_field_ref(self, field_ref: FieldRef<'_>) -> FieldQueryBuilder

Specifies a field to search in using a FieldRef

This ensures the field actually exists in a model. This must be followed by one of the field content methods like contains.

pub fn has_tag<S: AsRef<str>>(self, tag: S) -> Self

Searches for cards with a specific tag

pub fn in_deck<S: AsRef<str>>(self, deck: S) -> Self

Searches for cards in a specific deck

pub fn in_deck_obj(self, deck: &Deck) -> Self

Searches for cards in the specified deck object

pub fn in_state(self, state: CardState) -> Self

Searches for cards in a specific card state

pub fn not(self) -> Self

Negates the next condition

pub fn and(self) -> Self

Combines with the next condition using AND (implicit in Anki)

pub fn or(self) -> Self

Combines with the next condition using OR

pub fn has_flag(self, flag: Flag) -> Self

Searches for cards with a specific flag

pub fn interval_at_least(self, days: u32) -> Self

Searches for cards with an interval greater than or equal to the specified days

pub fn due_in(self, days: i32) -> Self

Searches for cards due in the specified number of days

pub fn reps_less_than(self, count: u32) -> Self

Searches for cards with fewer than the specified number of repetitions

pub fn added_in_last_n_days(self, days: u32) -> Self

Searches for cards added within the last n days

pub fn rated_today(self) -> Self

Searches for cards rated today

pub fn rated_in_last_n_days(self, days: u32) -> Self

Searches for cards rated within the last n days

pub fn build(self) -> Query

Builds the final query

impl QueryBuilder

Convenience functions for common queries

pub fn deck<S: AsRef<str>>(deck: S) -> Self

Creates a query that searches for cards in the specified deck

pub fn tag<S: AsRef<str>>(tag: S) -> Self

Creates a query that searches for cards with the specified tag

pub fn state(state: CardState) -> Self

Creates a query that searches for cards in the specified state

pub fn flag(flag: Flag) -> Self

Creates a query that searches for cards with the specified flag

Trait Implementations

impl Clone for QueryBuilder

fn clone(&self) -> QueryBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryBuilder

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

Formats the value using the given formatter.

impl Default for QueryBuilder

fn default() -> Self

Returns the “default value” for a type.