Skip to main content

Module event

Module event 

Source
Expand description

The typed execution event: one envelope, a closed set of payloads, and a version.

An event is a domain fact, not a message of a transport. The WebSocket endpoint, the history route, the audit line and anything added later render the same value; nothing downstream may add a field, and nothing upstream may send a string a consumer has to parse. The schema every client validates against is derived from these types by schemars, exactly as a capability’s input and output schemas are.

Structs§

ExecutionEvent
One event about one execution.

Enums§

EventPayload
What happened, as a closed set.

Constants§

PROTOCOL_VERSION
The version of the event protocol this executable speaks.

Functions§

sanitise
Text as an event may carry it: no control character, no terminal escape sequence, and bounded.