Struct NoteBuilder 

pub struct NoteBuilder { /* private fields */ }

Builder for creating notes with a fluent API.

Example

use ankit::NoteBuilder;

let note = NoteBuilder::new("My Deck", "Basic")
    .field("Front", "What is the capital of France?")
    .field("Back", "Paris")
    .tag("geography")
    .tag("europe")
    .build();

Implementations

impl NoteBuilder

pub fn new(deck: impl Into<String>, model: impl Into<String>) -> NoteBuilder

Create a new note builder.

Arguments

• deck - The deck name to add the note to
• model - The note type (model) name

pub fn field( self, name: impl Into<String>, value: impl Into<String>, ) -> NoteBuilder

Set a field value.

Field names are case-sensitive and must match the model exactly. Values are HTML - use < for literal <.

pub fn tag(self, tag: impl Into<String>) -> NoteBuilder

Add a tag to the note.

pub fn tags( self, tags: impl IntoIterator<Item = impl Into<String>>, ) -> NoteBuilder

Add multiple tags to the note.

pub fn audio(self, attachment: MediaAttachment) -> NoteBuilder

Add an audio attachment.

pub fn video(self, attachment: MediaAttachment) -> NoteBuilder

Add a video attachment.

pub fn picture(self, attachment: MediaAttachment) -> NoteBuilder

Add a picture attachment.

pub fn allow_duplicate(self, allow: bool) -> NoteBuilder

Allow duplicate notes.

pub fn duplicate_scope(self, scope: DuplicateScope) -> NoteBuilder

Set the duplicate checking scope.

pub fn duplicate_scope_deck(self, deck: impl Into<String>) -> NoteBuilder

Set the deck to check for duplicates in.

pub fn build(self) -> Note

Build the note.

Trait Implementations

impl Clone for NoteBuilder

fn clone(&self) -> NoteBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NoteBuilder

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

Formats the value using the given formatter.

impl Default for NoteBuilder

fn default() -> NoteBuilder

Returns the “default value” for a type.