Enum Error 

pub enum Error {
    Http(Error),
    AnkiConnect(String),
    EmptyResponse,
    Json(Error),
    ConnectionRefused,
    PermissionDenied,
    NoteValidation(String),
    Config(String),
}

The error type for AnkiConnect operations.

Common Patterns

Checking if Anki is Running

use ankit::{AnkiClient, Error};

let client = AnkiClient::new();

// Try a simple operation to check connectivity
match client.misc().version().await {
    Ok(version) => println!("Connected to AnkiConnect v{}", version),
    Err(Error::ConnectionRefused) => {
        return Err(Error::ConnectionRefused);
    }
    Err(e) => return Err(e),
}

Handling Duplicate Notes

use ankit::{AnkiClient, NoteBuilder, Error};

let client = AnkiClient::new();
let note = NoteBuilder::new("Default", "Basic")
    .field("Front", "Hello")
    .field("Back", "World")
    .build();

match client.notes().add(note).await {
    Ok(id) => println!("Created note {}", id),
    Err(Error::AnkiConnect(msg)) if msg.contains("duplicate") => {
        println!("Note already exists");
    }
    Err(e) => return Err(e),
}

Variants

Http(Error)

HTTP/network error from reqwest.

Typically indicates network issues unrelated to Anki. For connection issues, see Error::ConnectionRefused.

AnkiConnect(String)

AnkiConnect returned an error message.

The message string contains details about what went wrong. Common messages include:

• “cannot create note because it is a duplicate”
• “deck was not found”
• “model was not found”

EmptyResponse

Response was empty (no result or error).

This is unexpected and may indicate an AnkiConnect bug.

Json(Error)

JSON serialization/deserialization error.

May occur if AnkiConnect returns unexpected data formats.

ConnectionRefused

Connection refused - Anki is likely not running.

This error occurs when:

• Anki is not running
• The AnkiConnect add-on is not installed
• AnkiConnect is configured on a different port

PermissionDenied

Permission denied by AnkiConnect.

This occurs when:

• An API key is required but not provided
• The provided API key is incorrect
• A request requires user approval in the Anki UI

NoteValidation(String)

Note validation failed.

The note could not be added due to validation issues (e.g., missing required fields).

Config(String)

Invalid configuration.

A configuration value was invalid or inconsistent.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.