Struct Note

pub struct Note { /* private fields */ }

Represents a note in Anki

Implementations

impl Note

pub fn new( model: Model, field_values: HashMap<String, String>, tags: HashSet<String>, media: Vec<FieldMedia>, ) -> Result<Self, NoteError>

Creates a new note with validation

pub fn with_id( id: NoteId, model: Model, field_values: HashMap<String, String>, tags: HashSet<String>, media: Vec<FieldMedia>, ) -> Result<Self, NoteError>

Creates a note with an existing ID (for notes retrieved from Anki)

pub fn id(&self) -> Option<NoteId>

Gets the ID of this note, if it has one

pub fn model(&self) -> &Model

Gets the model (note type) of this note

pub fn field_values(&self) -> &HashMap<String, String>

Gets the field values of this note

pub fn field_value(&self, field_name: &str) -> Option<&String>

Gets a specific field value

pub fn tags(&self) -> &HashSet<String>

Gets all tags on this note

pub fn media(&self) -> &[FieldMedia]

Gets media attached to this note

pub fn has_tag(&self, tag: &str) -> bool

Returns true if this note has the given tag

pub fn update_field( &mut self, field_name: &str, value: String, ) -> Result<(), NoteError>

Updates a field value

pub fn add_tag(&mut self, tag: String)

Adds a tag

pub fn remove_tag(&mut self, tag: &str) -> bool

Removes a tag

pub fn add_media( &mut self, field_name: &str, media: Media, ) -> Result<(), NoteError>

Adds media to a field

pub fn front_value(&self) -> Option<&String>

Gets the value for the front (question) field

pub fn back_value(&self) -> Option<&String>

Gets the value for the back (answer) field

Trait Implementations

impl Clone for Note

fn clone(&self) -> Note

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Note

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

Formats the value using the given formatter.