Skip to main content

DeckExporter

Struct DeckExporter 

Source
pub struct DeckExporter<'a> { /* private fields */ }
Expand description

Exports decks from Anki to TOML format.

Uses AnkiConnect to fetch deck contents and convert them to a DeckDefinition that can be serialized to TOML.

Implementations§

Source§

impl<'a> DeckExporter<'a>

Source

pub fn new(client: &'a AnkiClient) -> Self

Create a new exporter with the given AnkiConnect client.

Source

pub async fn export_deck(&self, deck_name: &str) -> Result<DeckDefinition>

Export a deck to a DeckDefinition.

Fetches all notes in the specified deck, along with the models (note types) they use, and converts them to a TOML-compatible definition.

§Arguments
  • deck_name - The name of the deck to export (supports hierarchical names like “Parent::Child”)
§Example
use ankit::AnkiClient;
use ankit_builder::DeckExporter;

let client = AnkiClient::new();
let exporter = DeckExporter::new(&client);

let definition = exporter.export_deck("My Deck").await?;
println!("Exported {} notes", definition.notes.len());
Source

pub async fn export_decks( &self, deck_names: &[&str], package_name: &str, ) -> Result<DeckDefinition>

Export multiple decks to a single DeckDefinition.

Useful for exporting a parent deck and its children, or a set of related decks.

§Arguments
  • deck_names - The names of the decks to export
  • package_name - The name for the package (used in [package] section)
§Example
use ankit::AnkiClient;
use ankit_builder::DeckExporter;

let client = AnkiClient::new();
let exporter = DeckExporter::new(&client);

let definition = exporter
    .export_decks(&["Japanese::N5", "Japanese::N4"], "Japanese JLPT")
    .await?;

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for DeckExporter<'a>

§

impl<'a> !UnwindSafe for DeckExporter<'a>

§

impl<'a> Forget for DeckExporter<'a>

§

impl<'a> Freeze for DeckExporter<'a>

§

impl<'a> Send for DeckExporter<'a>

§

impl<'a> Sync for DeckExporter<'a>

§

impl<'a> Unpin for DeckExporter<'a>

§

impl<'a> UnsafeUnpin for DeckExporter<'a>

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