Struct Note

pub struct Note { /* private fields */ }

Note (Flashcard) to be added to a Deck

Implementations

impl Note

pub fn new(model: Model, fields: Vec<&str>) -> Result<Self, Error>

Creates a new Note with a new model and fields

Returns Err if the fields are not matching the model or if the fields are invalid

Example:

use genanki_rs::{Note, basic_model};

let note = Note::new(basic_model(), vec!["What is the capital of France?", "Paris"]);

pub fn new_with_options( model: Model, fields: Vec<&str>, sort_field: Option<bool>, tags: Option<Vec<&str>>, guid: Option<&str>, ) -> Result<Self, Error>

Creates a new Note with a new model, fields and custom parameters:

• sort_field - whether to sort field, default is false
• tags - List of tags
• guid - Custom unique note id, default is hash of all fields

Returns Err if tags or fields are invalid

pub fn sort_field(self, sort_field: bool) -> Self

Returns a new Note with the sort field replace with the new one

pub fn tags(self, tags: impl IntoIterator<Item = impl ToString>) -> Self

Sets or replaces tags with the provided ones

pub fn with_tag(self, tag: impl ToString) -> Self

Adds an additional tag

pub fn guid(self, guid: impl ToString) -> Self

Sets the GUID for this note

The GUID is auto-generated if this option is not provided.

Trait Implementations

impl Clone for Note

fn clone(&self) -> Note

Returns a duplicate of the value.

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

Performs copy-assignment from source.