Struct Engine 

pub struct Engine { /* private fields */ }

High-level workflow engine for Anki operations.

The engine wraps an AnkiClient and provides access to workflow modules that combine multiple API calls into cohesive operations.

Example

use ankit_engine::Engine;

// Create with default client settings
let engine = Engine::new();

// Or with a custom client
let client = ankit_engine::AnkiClient::builder()
    .url("http://localhost:8765")
    .build();
let engine = Engine::from_client(client);

// Access workflow modules
let stats = engine.analyze().study_summary("Default", 7).await?;

Implementations

impl Engine

pub fn new() -> Self

Create a new engine with default client settings.

Connects to AnkiConnect at http://127.0.0.1:8765.

pub fn from_client(client: AnkiClient) -> Self

Create an engine from an existing client.

pub fn client(&self) -> &AnkiClient

Get a reference to the underlying client.

Use this for direct API access when workflows don’t cover your use case.

pub fn import(&self) -> ImportEngine<'_>

Access import workflows.

Provides bulk import with duplicate detection and conflict resolution.

pub fn export(&self) -> ExportEngine<'_>

Access export workflows.

Provides deck export and review history extraction.

pub fn organize(&self) -> OrganizeEngine<'_>

Access organization workflows.

Provides deck cloning, merging, and tag-based reorganization.

pub fn analyze(&self) -> AnalyzeEngine<'_>

Access analysis workflows.

Provides study statistics and problem card (leech) detection.

pub fn migrate(&self) -> MigrateEngine<'_>

Access migration workflows.

Provides note type migration with field mapping.

pub fn media(&self) -> MediaEngine<'_>

Access media workflows.

Provides media audit and cleanup operations.

pub fn progress(&self) -> ProgressEngine<'_>

Access progress management workflows.

Provides card state management, performance tagging, and bulk operations.

pub fn enrich(&self) -> EnrichEngine<'_>

Access enrichment workflows.

Provides tools for finding notes with empty fields and updating them.

pub fn deduplicate(&self) -> DeduplicateEngine<'_>

Access deduplication workflows.

Provides duplicate detection and removal based on key fields.

pub fn backup(&self) -> BackupEngine<'_>

Access backup and restore workflows.

Provides deck backup to .apkg files and restore operations.

pub fn search(&self) -> SearchEngine<'_>

Access content search helpers.

Provides simplified search methods that return full note info instead of just IDs, abstracting away Anki query syntax.

Example

let engine = Engine::new();

// Search for text in any field
let notes = engine.search().text("conjugation", Some("Japanese")).await?;

// Search in a specific field
let notes = engine.search().field("Front", "hello", None).await?;

Trait Implementations

impl Clone for Engine

fn clone(&self) -> Engine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Engine

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

Formats the value using the given formatter.

impl Default for Engine

fn default() -> Self

Returns the “default value” for a type.