pub struct DeckDefinition {
pub package: PackageInfo,
pub models: Vec<ModelDef>,
pub decks: Vec<DeckDef>,
pub notes: Vec<NoteDef>,
pub media: Vec<MediaDef>,
}Expand description
Root structure for a deck definition file.
Fields§
§package: PackageInfoPackage metadata.
models: Vec<ModelDef>Model (note type) definitions.
decks: Vec<DeckDef>Deck definitions.
notes: Vec<NoteDef>Note definitions.
media: Vec<MediaDef>Media file definitions.
Implementations§
Source§impl DeckDefinition
impl DeckDefinition
Sourcepub fn from_file(path: impl AsRef<Path>) -> Result<Self>
pub fn from_file(path: impl AsRef<Path>) -> Result<Self>
Load a deck definition from a TOML file.
Sourcepub fn notes_for_deck(&self, deck_name: &str) -> impl Iterator<Item = &NoteDef>
pub fn notes_for_deck(&self, deck_name: &str) -> impl Iterator<Item = &NoteDef>
Get notes for a specific deck.
Sourcepub fn html_to_markdown(&mut self)
pub fn html_to_markdown(&mut self)
Convert HTML to Markdown in fields marked as markdown_fields.
Call this after exporting from Anki to get cleaner, more readable TOML.
§Example
use ankit_builder::DeckDefinition;
let mut definition = DeckDefinition::from_file("deck.toml")?;
definition.html_to_markdown();
definition.write_toml("deck_markdown.toml")?;Sourcepub fn markdown_to_html(&mut self)
pub fn markdown_to_html(&mut self)
Convert Markdown to HTML in fields marked as markdown_fields.
Call this before importing to Anki to convert readable Markdown to HTML.
§Example
use ankit_builder::DeckDefinition;
let mut definition = DeckDefinition::from_file("deck.toml")?;
definition.markdown_to_html();
// Now ready to import to AnkiSourcepub fn set_markdown_fields(&mut self, model_name: &str, fields: &[&str])
pub fn set_markdown_fields(&mut self, model_name: &str, fields: &[&str])
Set markdown fields for a model.
Convenience method to mark which fields should use Markdown format.
§Example
use ankit_builder::DeckDefinition;
let mut definition = DeckDefinition::from_file("deck.toml")?;
definition.set_markdown_fields("Basic", &["Back", "Extra"]);Source§impl DeckDefinition
impl DeckDefinition
Trait Implementations§
Source§impl Clone for DeckDefinition
impl Clone for DeckDefinition
Source§impl Debug for DeckDefinition
impl Debug for DeckDefinition
Source§impl<'de> Deserialize<'de> for DeckDefinition
impl<'de> Deserialize<'de> for DeckDefinition
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl Forget for DeckDefinition
impl Freeze for DeckDefinition
impl RefUnwindSafe for DeckDefinition
impl Send for DeckDefinition
impl Sync for DeckDefinition
impl Unpin for DeckDefinition
impl UnsafeUnpin for DeckDefinition
impl UnwindSafe for DeckDefinition
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more