Skip to main content

Module envelope

Module envelope 

Source
Expand description

Response envelope, warnings, and the state token.

Per docs/PROTOCOL.md § “Response envelope”:

  • @<token> — success.
  • ! <CODE> [arg]... — error.
  • ? <code> [arg]... — warning (one per line, before the success envelope).

The full message envelope (warnings + success/error + body) is composed by callers; this module deals with the individual lines.

Structs§

ResponseHead
A response head: zero or more warnings followed by an envelope.
StateToken
A 64-bit state token, rendered as 16 lowercase hex chars on the wire.
Warning
One warning line, preceding the success envelope.

Enums§

Envelope
The single envelope line on a response.