Struct genanki_rs::Deck

pub struct Deck { /* fields omitted */ }

A flashcard deck which can be written into an .apkg file.

Implementations

impl Deck

pub fn new(id: usize, name: &str, description: &str) -> Self

Creates a new deck with an id, name and description.

id should always be unique when creating multiple decks.

pub fn add_note(&mut self, note: Note)

Adds a note (Flashcard) to the deck.

Example:

use genanki_rs::{Deck, Note, basic_model};

let mut my_deck = Deck::new(1234, "Example deck", "This is an example deck");
my_deck.add_note(Note::new(basic_model(), vec!["What is the capital of France?", "Paris"])?);

pub fn write_to_file(self, file: &str) -> Result<(), Error>

Packages a deck and writes it to a new .apkg file. This file can then be imported in Anki.

Returns Err if the file can not be created.

Example:

use genanki_rs::{Deck, Note, basic_model};

let mut my_deck = Deck::new(1234, "Example deck", "This is an example deck");
my_deck.add_note(Note::new(basic_model(), vec!["What is the capital of France?", "Paris"])?);

my_deck.write_to_file("output.apkg")?;

This is equivalent to:

use genanki_rs::{Deck, Note, basic_model, Package};

let mut my_deck = Deck::new(1234, "Example deck", "This is an example deck");
my_deck.add_note(Note::new(basic_model(), vec!["What is the capital of France?", "Paris"])?);

Package::new(vec![my_deck], vec![])?.write_to_file("output.apkg")?;

Trait Implementations

impl Clone for Deck

fn clone(&self) -> Deck

Returns a copy of the value.

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

Performs copy-assignment from source.