Struct SearchEngine 

pub struct SearchEngine<'a> { /* private fields */ }

Content search engine for finding notes.

Implementations

impl<'a> SearchEngine<'a>

pub async fn text( &self, text: &str, deck: Option<&str>, ) -> Result<Vec<NoteInfo>>

Search for text in any field.

Returns notes containing the exact phrase in any field.

Arguments

• text - Text to search for (exact phrase match)
• deck - Optional deck to limit search to

Example

let engine = Engine::new();

// Search all decks
let notes = engine.search().text("example sentence", None).await?;

// Search specific deck
let notes = engine.search().text("verb", Some("Italian")).await?;

pub async fn field( &self, field_name: &str, text: &str, deck: Option<&str>, ) -> Result<Vec<NoteInfo>>

Search for text in a specific field.

Arguments

• field_name - Name of the field to search in
• text - Text to search for
• deck - Optional deck to limit search to

Example

let engine = Engine::new();

let notes = engine.search().field("Front", "mangiare", Some("Italian")).await?;

pub async fn regex( &self, field_name: &str, pattern: &str, deck: Option<&str>, ) -> Result<Vec<NoteInfo>>

Search with regex in a specific field.

Arguments

• field_name - Name of the field to search in
• pattern - Regex pattern
• deck - Optional deck to limit search to

Example

let engine = Engine::new();

// Find notes where Back field starts with "to "
let notes = engine.search().regex("Back", r"^to\s+", None).await?;

pub async fn wildcard( &self, field_name: &str, pattern: &str, deck: Option<&str>, ) -> Result<Vec<NoteInfo>>

Search with wildcards in a specific field.

Use * for any sequence of characters, _ for single character.

Arguments

• field_name - Name of the field to search in
• pattern - Wildcard pattern (e.g., *tion, h_llo)
• deck - Optional deck to limit search to

Example

let engine = Engine::new();

// Find notes ending with "tion"
let notes = engine.search().wildcard("Front", "*tion", None).await?;

pub async fn empty_field( &self, field_name: &str, deck: Option<&str>, ) -> Result<Vec<NoteInfo>>

Find notes where a field is empty.

Arguments

• field_name - Name of the field to check
• deck - Optional deck to limit search to

Example

let engine = Engine::new();

// Find notes missing examples
let notes = engine.search().empty_field("Example", Some("Vocabulary")).await?;

pub async fn query(&self, query: &str) -> Result<Vec<NoteInfo>>

Search with a custom query built using QueryBuilder.

This allows combining the content search with full QueryBuilder capabilities.

Example

use ankit::QueryBuilder;
let engine = Engine::new();

let query = QueryBuilder::new()
    .deck("Japanese")
    .is_due()
    .not_suspended()
    .lapses_gte(3)
    .build();

let notes = engine.search().query(&query).await?;

Trait Implementations

impl<'a> Debug for SearchEngine<'a>

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

Formats the value using the given formatter.