Skip to main content

Module manifest

Module manifest 

Expand description

examples/parity.toml — the single source of what must agree.

The grammar is docs/design/11-documentation-plan.md §17.5. Every rule in it is a rejection here, because the manifest’s job is to make silent exclusion impossible (§6.2): an example that is in neither a pair nor an unpaired entry is a parse error, so adding an example forces a decision about it.

Structs§

Manifest
The whole manifest.
Pair
One pair that must agree.

Enums§

Arm 🔒
Which language an unpaired entry names.

Constants§

MANIFEST
The manifest, relative to the repository root.
NOT_EXAMPLES 🔒
Directory names never descended into while listing examples.
PYTHON_DIR
Where the Python arms live, relative to the repository root.
PYTHON_NON_EXAMPLES 🔒
The Python files under PYTHON_DIR that are harness, not examples.
RUST_DIR
Where the Rust arms live, relative to the repository root.

Functions§

array_of_tables 🔒
Returns the tables of an array-of-tables key.
forbid_fused_multiply_add 🔒
Fails when a paired Rust arm computes with a fused multiply-add.
require_file 🔒
Fails when a named file does not exist.
required_string 🔒
Reads a required string field.
rust_sources
Every Rust example source under RUST_DIR, as /-separated relative paths.
sources 🔒
Every file with extension under path, relative to it and /-separated.
string_value 🔒
Reads a string field’s value.
unclaimed 🔒
Fails when a file on disk appears in no entry.