pub struct ConnectImporter { /* private fields */ }Expand description
Imports deck definitions into Anki via AnkiConnect.
ConnectImporter handles the live import of notes into a running Anki
instance. It automatically creates missing decks but requires that all
referenced note types (models) already exist.
§Import Methods
import(): Adds notes one at a time (safer, better error tracking)import_batch(): Adds all notes in a single call (faster)
§Validation
Use validate_models() and validate_decks()
to check prerequisites before importing.
Implementations§
Source§impl ConnectImporter
impl ConnectImporter
Sourcepub fn new(definition: DeckDefinition) -> Self
pub fn new(definition: DeckDefinition) -> Self
Create a new importer from a deck definition.
Sourcepub fn with_client(definition: DeckDefinition, client: AnkiClient) -> Self
pub fn with_client(definition: DeckDefinition, client: AnkiClient) -> Self
Create a new importer with a custom AnkiConnect client.
Sourcepub async fn import(&self) -> Result<ImportResult>
pub async fn import(&self) -> Result<ImportResult>
Import the deck definition into Anki.
This will:
- Create any missing decks
- Add all notes (using existing models)
Note: Models must already exist in Anki. This method does not create models.
Sourcepub async fn import_batch(&self) -> Result<ImportResult>
pub async fn import_batch(&self) -> Result<ImportResult>
Import notes in batches for better performance.
Note: Models must already exist in Anki. This method does not create models.
Sourcepub async fn validate_models(&self) -> Result<Vec<String>>
pub async fn validate_models(&self) -> Result<Vec<String>>
Check if all required models exist in Anki.
Returns a list of model names that are defined in the TOML but do not exist in Anki. An empty list means all models are available.
Unlike decks, models cannot be created automatically and must exist before import. Use this to warn users or fail early.
§Example
use ankit_builder::{ConnectImporter, DeckDefinition};
let definition = DeckDefinition::from_file("deck.toml")?;
let importer = ConnectImporter::new(definition);
let missing = importer.validate_models().await?;
if !missing.is_empty() {
eprintln!("Please create these note types in Anki first:");
for model in &missing {
eprintln!(" - {}", model);
}
}Sourcepub async fn validate_decks(&self) -> Result<Vec<String>>
pub async fn validate_decks(&self) -> Result<Vec<String>>
Check if all required decks exist in Anki.
Returns a list of deck names that are defined in the TOML but do not exist in Anki. An empty list means all decks are available.
Note that import() automatically creates missing decks,
so this is mainly useful for informational purposes.
§Example
use ankit_builder::{ConnectImporter, DeckDefinition};
let definition = DeckDefinition::from_file("deck.toml")?;
let importer = ConnectImporter::new(definition);
let missing = importer.validate_decks().await?;
if !missing.is_empty() {
println!("Will create {} new decks", missing.len());
}