Skip to main content

Module read

headless_lms_mcp::engine

Module read

Expand description

Read selectors shared by get_page_content, get_course_structure and read_back.

Results carry ids and ready-made paths only; offsets exist in requests, and a paged read continues from an id-anchored next selector.

Re-exports§

pub use page::read_page;
pub use structure::read_structure;

Modules§

page 🔒: Read selectors over a page’s blocks.
structure 🔒: Read selectors over the course structure.
window 🔒: Windows over lists of units that fill a byte budget, shared by the page and structure reads.

Structs§

ReadOptions: Read settings the caller derives from the client and the staged changeset.
ReadResult: One selector’s result.
Selector: What to read. All fields are optional; an empty selector is an outline of the whole page or course.

Enums§

ReadMode: How much of each item a read returns.
ReadState: Which state of the course a read sees.
StopReason: Why a read returned fewer items than its selector covers.

Functions§

check_selector 🔒: Rejects selector field combinations that have no meaning.
field_result 🔒: The result of reading one field.