Skip to main content

DeckDefinition

Struct DeckDefinition 

Source
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: PackageInfo

Package 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

Source

pub fn from_file(path: impl AsRef<Path>) -> Result<Self>

Load a deck definition from a TOML file.

Source

pub fn parse(content: &str) -> Result<Self>

Parse a deck definition from a TOML string.

Source

pub fn validate(&self) -> Result<()>

Validate the deck definition for consistency.

Source

pub fn get_model(&self, name: &str) -> Option<&ModelDef>

Get a model by name.

Source

pub fn get_deck(&self, name: &str) -> Option<&DeckDef>

Get a deck by name.

Source

pub fn notes_for_deck(&self, deck_name: &str) -> impl Iterator<Item = &NoteDef>

Get notes for a specific deck.

Source

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")?;
Source

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 Anki
Source

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

Source

pub fn write_toml(&self, path: impl AsRef<Path>) -> Result<()>

Write the deck definition to a TOML file.

§Example
use ankit_builder::DeckDefinition;

let definition = DeckDefinition::from_file("input.toml")?;
// ... modify definition ...
definition.write_toml("output.toml")?;
Source

pub fn to_toml(&self) -> Result<String>

Serialize the deck definition to a TOML string.

§Example
use ankit_builder::DeckDefinition;

let definition = DeckDefinition::from_file("input.toml")?;
let toml_string = definition.to_toml()?;
println!("{}", toml_string);

Trait Implementations§

Source§

impl Clone for DeckDefinition

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DeckDefinition

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for DeckDefinition

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for DeckDefinition

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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