Skip to main content

Module api

Expand description

The six contract endpoints, one stage boundary at a time.

Order per request: credential, parse, item-keyed load, the auth/requestGate/parse faults, resolve request-level then per item, then afterWrite and respond. The write-back commits before the response β€” or its deliberate absence β€” leaves the process, which is what makes a timeout that landed distinguishable from one that did not.

MacrosΒ§

endpoint_handlers πŸ”’
Actix binds one handler per route, so the endpoint each route serves is all these differ by.

StructsΒ§

FaultRunner πŸ”’
Terminal πŸ”’
What a request-shaped effect answers with instead of the per-item array.

EnumsΒ§

Delivery πŸ”’
ParsedRequest πŸ”’

ConstantsΒ§

RAW_BODY_LIMIT πŸ”’

FunctionsΒ§

authorized πŸ”’
credential_accepted πŸ”’
Scheme-agnostic: whatever word the client puts in front, the credential after it is what is checked.
deliver πŸ”’
endpoint πŸ”’
finish πŸ”’
Commits, then hands back what to send.
import_attainments
item_effect_response πŸ”’
A disclosed id is taken from the outcome the item already had, which is what makes β€œtimed out, but it landed” expressible.
list_by_course
load πŸ”’
malformed πŸ”’
parse πŸ”’
parse_items πŸ”’
Parses per element so the message can name the offending index, which serde’s line and column cannot.
resolve_enrolments
resolve_persons
resolve_product_access_tokens
resolve_world πŸ”’
run πŸ”’
terminal πŸ”’
None for an item-level effect, which shapes one item rather than the whole answer.
truncate πŸ”’
unique_field πŸ”’
Collects the distinct values of one field across a request’s items, in first-seen order.
verify_attainments

Type AliasesΒ§

ParseFailure πŸ”’
The error half is the request-level code and its message.