Struct Catalog 

pub struct Catalog { /* private fields */ }

All sections and levels. Iteration, Catalog::next and Catalog::prev follow the course order, which is numeric on (section, number), whatever order the sections and levels were declared in.

Implementations

impl Catalog

pub fn new(sections: Vec<Section>) -> Self

Collect sections into a catalog. Nothing is rejected here (a malformed catalog is Catalog::validate’s to report), so building one never panics.

pub fn len(&self) -> usize

The number of levels.

pub fn is_empty(&self) -> bool

True when there are no levels.

pub fn iter(&self) -> impl Iterator<Item = (&Section, &Level)> + '_

Every level with its section, in course order.

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

The ids of all levels, in course order.

pub fn sections(&self) -> &[Section]

The sections, ordered by number.

pub fn section(&self, number: u16) -> Option<&Section>

The section with this number.

pub fn get(&self, id: LevelId) -> Option<(&Section, &Level)>

The level with this id and the section it belongs to.

pub fn first(&self) -> Option<LevelId>

The first level of the course.

pub fn last(&self) -> Option<LevelId>

The last level of the course.

pub fn next(&self, id: LevelId) -> Result<Option<LevelId>, UnknownLevelError>

The level after id, or Ok(None) when id is the last one.

pub fn prev(&self, id: LevelId) -> Result<Option<LevelId>, UnknownLevelError>

The level before id, or Ok(None) when id is the first one.

pub fn resolve_or_nearest(&self, id: LevelId) -> Option<LevelId>

Map a possibly stale saved id onto a level that exists.

Levels get renumbered between versions, which would otherwise leave a saved game permanently unplayable. Resolution keeps the player as close as possible to where they were: the level itself if it exists, otherwise the nearest later level, and the last level when the id is past the end. None only for an empty catalog.

pub fn resolve_str(&self, raw: &str) -> Option<LevelId>

Catalog::resolve_or_nearest for a saved id that may not even parse: a malformed one resolves to the first level.

pub fn validate(&self) -> Vec<String>

Everything wrong with the catalog, as human-readable lines that start with the level id (or section N). Empty means the catalog is sound.

Structure: unique ids, intro if and only if number 0, every regular level has an answer or a requirement and a solution. Paths: every declared path is a plain relative path that does not restate its section root, fixtures do not target their root. Pairing: cd_evidence needs a cd policy, fd_evidence needs on_fd. Content: the answer never appears in error, mistake or format messages, a secret answer never appears in hints or as shellgame submit <answer>, custom at messages do not name their target, no hint is empty, and every accepts / rejects example behaves as declared.

Debug builds run this at startup, so a malformed level fails on cargo run.

Trait Implementations

impl Clone for Catalog

fn clone(&self) -> Catalog

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Catalog

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a Catalog

type Item = (&'a Section, &'a Level)

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = (&'a Section, &'a Level)> + 'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.