Skip to main content

Module event

Module event 

Source
Expand description

The history: one closed pair of an event kind and the payload it carries.

EventKind and EventPayload are one closed pair rather than two fields that happen to agree. Every kind has exactly one payload variant and every payload variant has exactly one kind, so a consumer that matches the kind knows the payload’s shape, and a mismatched pair is unrepresentable rather than merely undocumented: an EventRecord carries the payload, the kind on the wire is that payload’s own tag, and a serialized record naming one kind while carrying another’s payload fails to parse.

Structs§

ActionExecutedPayload
An accepted action reached the printer.
ActionRejectedPayload
Policy refused an action.
ActionRequestedPayload
An actor asked for an action.
AgentAssessmentPayload
The agent wrote down what it made of a turn.
EventRecord
One event, as the store holds it.
InterventionExpiredPayload
A bounded intervention expired.
MalformedExternalEventPayload
An external body arrived that could not be read.
ObicoFailureAlertPayload
Obico reported a print failure.
ObicoPrinterNotificationPayload
Obico sent a printer notification.
OperatorAcknowledgementPayload
An operator acknowledged an event.
PortFailurePayload
A port failed while one event was being handled.
StartupReconciliationPayload
A supervisor reconciled one thing the store held when it started.
SupervisionSessionClosedPayload
A supervision session was closed.
SupervisionSessionOpenedPayload
A supervision session was opened.

Enums§

EventKind
Which event this is, without its payload.
EventPayload
What an event carries, tagged by the kind it belongs to.
EventSource
Where an event came from.
ObicoNotificationType
The kind of printer notification Obico sent, normalized.
PortFailureSite
Where a port failed while an event was being handled.
StartupOutcome
What one restart put back the way it found it.