Struct App

pub struct App {
    pub flipped: bool,
    pub opts: Opts,
    pub text: String,
    /* private fields */
}

App holds the state of the application

Fields

flipped: bool

This determines whether the card should show the question or the answer.

opts: Opts

The (command line) options of the App to determine how it willl run.

text: String

The currently entered text for Input questions. Reset when moving to a new questions.

Implementations

impl App

pub fn new(deck: Deck, opts: Opts) -> Self

Creates a new app from a deck of cards

pub fn order_playables(&mut self)

Put the playable cards in order based of their score

pub fn cards(&self) -> &[Card]

Returns an immutable copy of all the cards

pub fn dues(&self) -> HashMap<CardIdx, Option<DateTime<Utc>>>

Returns in immutable copy of when different cards are due.

The key is garunteed to probably be an index from [Self::cards]

pub fn scores(&self) -> HashMap<usize, usize>

Returns in immutable copy of each cards scores.

The key is garunteed to probably be an index from [Self::cards]

pub fn circulating(&self) -> &[CardIdx]

Returns a copy of cards which are mandatorily in circulation until answered correctly

pub fn flip(&mut self)

Flips the current card to show the other side.

pub fn playable_range(&self) -> usize

Gets the range of cards currently being played with.

pub fn shuffle(&mut self)

Shuffles the deck so you can play with different cards

pub fn shuffle_all(&mut self)

Shuffles the whole deck so you can play with different cards

pub fn retain_undue(&mut self)

Removes any cards which aren’t due from the deck

pub fn next_card(&mut self)

Moves on to the next card

pub fn card(&self) -> &Card

Gets the current card from the app.

pub fn card_mut(&mut self) -> &mut Card

Gets the current card from the app.

pub fn card_score(&self) -> usize

Gets the score of the current card from the app.

pub fn reset_current_card_duration(&mut self)

Resets the duration of the current card.

This will index DURATIONS and work out from that how far forth it should be due.

pub fn change_current_card_score(&mut self, val: isize)

Changes the score of the current card.

A card can not have a negative score. If the zeroize option is true then a negative val will set the score to zero.

pub fn current_card_is_finished(&self, card: usize) -> bool

Determines if the current card still should be played or if its due date has expired.

pub fn unfinished_count(&self) -> usize

Gets how many cards still need to be played.

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

Writes the scores recursively to the relevant files, as specified in App::opts.

pub fn add_scores(&mut self, scores: Scores, path: &Path)

Adds a [flashed::Scores] into an App

pub fn read_scores(&mut self) -> Result<()>

Reads and applies the scores from the file or directory, as specified in App::opts

pub fn get_paths(&self) -> Vec<&PathBuf>

Returns a list of all card paths in the deck

pub fn scores_from_path(&self, path: &Path) -> Scores

Gets the scores for all cards with the given path

Trait Implementations

impl Clone for App

fn clone(&self) -> App

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for App

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

Formats the value using the given formatter.

impl<'a> From<&'a App> for Scores

fn from(app: &App) -> Self

Converts to this type from the input type.