Skip to main content

Module model

Module model 

Source
Expand description

The typed model of a web surface: what it is, where it is mounted, what produced it, and where every value came from.

One vocabulary serves every consumer — the router, the static composition, the validator, the listing and the generated manifest — so a surface is described once and read many times. The kinds are behavioural rather than nominal: a test report and a benchmark report are both SurfaceKind::StaticDirectory and differ only in data, and nothing in this module knows the name of any surface this repository happens to have.

Structs§

Mount
A normalised mount path: absolute, without a trailing slash, without . or ...
Surface
One resolved surface: everything a consumer needs, with the provenance of what it could be surprised by.
Topology
Every surface this repository exposes, resolved together.

Enums§

Availability
Whether a surface is part of the static publication, served only while a process runs, or both.
Category
What a surface is for, which is how a reader is shown it.
Feature
A capability of the running process a surface needs in order to exist.
Provenance
Where a resolved value came from.
SurfaceKind
How a surface answers a request.
Visibility
Who a surface is offered to.