Module surface
Expand description
A resource kind’s public surface as data: its verbs with their
parameters and kinds, and its fields with their schema. An app’s
surface.toml holds it (written by tilo-app surface from the code), and
it is what a receiver without the app knows about the app’s changes.
The file keeps what receipt and the storage check need. The labels,
descriptions, field titles and owners the code reports are for people and
history; tilo-app surface leaves them out of the file, so they read as
empty here.
Structs§
- Field
Surface - One stored field.
- Named
Type - A record or enum with a name, declared once in a surface’s types.
- Param
Surface - One parameter of a verb.
- Surface
- The public surface of one resource kind. See the module docs.
- Type
Case - A case of a named enum, with the fields its value carries.
- Type
Field - A field of a named record or of an enum case.
- TypeSet
- The named types a surface declares, gathered while its fields’ types are worked out: each declared once under one name, however often it is used.
- Verb
Surface - One verb.
Enums§
- Field
Type - A field’s or value’s type. See the module docs.
Constants§
- RECORD_
UNIT - The record unit, as footprints and unit indexes name it.
- STORED_
VALUE - How a field holding a plain value is stored.
Functions§
- nest_
arguments - The arguments of a call of
verb, as(name, value), with each argument of a parameter published as a field of another (ParamSurface::within) nested back under that parameter’s name: what the action’s door reads.