Module path 

The path grammar the engines share: segments with JSON Pointer escapes, ids and $labels, and block paths.

Enums

BlockPart 🔒

What follows the root of a BlockPath.

BlockPath 🔒

A block path split into its parts, before its id or label is resolved.

ItemRef 🔒

How an id-or-label reference outside a path (from, to_page, reorder values) was written.

Functions

escape_segment 🔒

segment JSON Pointer escaped, to put in a path; the inverse of unescape_segment.

is_course_root 🔒

Whether a path’s first segment names the course: course or the course’s id.

parse_block_path 🔒

Splits a block path into its parts; None when it doesn’t start with /.

parse_item_ref 🔒

Parses pg7, /pg7, $x or /$x.

parse_uuid 🔒

Parses a path segment as an id. whole is the full path, quoted in the error.

split_path 🔒

The unescaped segments of a path; None when it doesn’t start with /.

split_segment 🔒

The first segment of path (no leading /) and the rest, which starts with / or is empty.

unescape_segment 🔒

A path segment with its JSON Pointer escapes (~1 for /, ~0 for ~) undone.