Struct Journey 

pub struct Journey { /* private fields */ }

Where a learner stands on the roadmap: every lesson in order, the ones done, the one open.

Implementations

impl Journey

pub fn new( order: Vec<String>, done: impl IntoIterator<Item = String>, remembered: Option<&str>, ) -> Self

order is every lesson id in roadmap order; done the lessons finished before (an id not on the roadmap is dropped). remembered is the lesson open last time: it opens again while it is on the roadmap, else the first lesson not done opens, else the first lesson.

pub fn open(&self) -> Option<&str>

The open lesson, or None for an empty roadmap.

pub fn next(&self) -> Option<&str>

The lesson after the open one.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn done_count(&self) -> usize

pub fn is_done(&self, id: &str) -> bool

pub fn is_finished(&self) -> bool

Whether every lesson on a non-empty roadmap is done.

pub fn done_ids(&self) -> impl Iterator<Item = &str> + '_

The lessons done, in id order.

pub fn finish(&mut self)

Mark the open lesson done. It stays open.

pub fn advance(&mut self) -> bool

Open the next lesson in roadmap order. false at the end of the roadmap.

pub fn open_lesson(&mut self, id: &str) -> bool

Open id. false when it is not on the roadmap.

pub fn open_first_unfinished(&mut self, ids: &[&str]) -> bool

Open the first of ids not done, or the first of them when all are done: how a link to a module opens it. false when none of ids is on the roadmap.

Trait Implementations

impl Clone for Journey

fn clone(&self) -> Journey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Journey

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

Formats the value using the given formatter.

impl PartialEq for Journey

fn eq(&self, other: &Journey) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Journey