Skip to main content

ConnectImporter

Struct ConnectImporter 

Source
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

Source

pub fn new(definition: DeckDefinition) -> Self

Create a new importer from a deck definition.

Source

pub fn with_client(definition: DeckDefinition, client: AnkiClient) -> Self

Create a new importer with a custom AnkiConnect client.

Source

pub async fn import(&self) -> Result<ImportResult>

Import the deck definition into Anki.

This will:

  1. Create any missing decks
  2. Add all notes (using existing models)

Note: Models must already exist in Anki. This method does not create models.

Source

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.

Source

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);
    }
}
Source

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());
}

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more