Struct genanki_rs::Package

pub struct Package { /* private fields */ }

Package to pack Decks and media_files and write them to a .apkg file

Example:

use genanki_rs::{Package, Deck, Note, Model, Field, Template};

let model = Model::new(
    1607392319,
    "Simple Model",
    vec![
        Field::new("Question"),
        Field::new("Answer"),
        Field::new("MyMedia"),
    ],
    vec![Template::new("Card 1")
        .qfmt("{{Question}}{{Question}}<br>{{MyMedia}}")
        .afmt(r#"{{FrontSide}}<hr id="answer">{{Answer}}"#)],
);

let mut deck = Deck::new(1234, "Example Deck", "Example Deck with media");
deck.add_note(Note::new(model.clone(), vec!["What is the capital of France?", "Paris", "[sound:sound.mp3]"])?);
deck.add_note(Note::new(model.clone(), vec!["What is the capital of France?", "Paris", r#"<img src="image.jpg">"#])?);

let mut package = Package::new(vec![my_deck], vec!["sound.mp3", "images/image.jpg"])?;
package.write_to_file("output.apkg")?;

Implementations

impl Package

pub fn new(decks: Vec<Deck>, media_files: Vec<&str>) -> Result<Self, Error>

Create a new package with decks and media_files

Returns Err if media_files are invalid

pub fn write<W: Write + Seek>(&mut self, writer: W) -> Result<(), Error>

Writes the package to any writer that implements Write and Seek

pub fn write_timestamp<W: Write + Seek>( &mut self, writer: W, timestamp: f64 ) -> Result<(), Error>

Writes the package to any writer that implements Write and Seek using a timestamp

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

Writes the package to a file

Returns Err if the file cannot be created

pub fn write_to_file_timestamp( &mut self, file: &str, timestamp: f64 ) -> Result<(), Error>

Writes the package to a file using a timestamp

Returns Err if the file cannot be created