Skip to main content

Module msg

Module msg 

Source
Expand description

Control messages. Every JSON frame is an object with a type field. From protocol 1, every message after the handshake also carries the id of the request it belongs to (Envelope).

Re-exports§

pub use crate::options::OptionField;

Structs§

ColumnOptions
One entry of a columns: map.
ConnectionField
DeliveryFile
One file of a multi-file deliver.
Envelope
A message with the id of the request it belongs to. Core numbers its requests; every reply, and every message streamed as part of a request (result_set_end, finish, result, result_end, log, progress), carries that request’s id. hello has none, and neither does anything a protocol 0 peer sends.
Message
A rendered message, as deliver carries it.
ResultSetMeta
Per result set, what a format plugin needs to lay it out.

Enums§

AutoWidth
The word auto.
ColumnWidth
A column width: sized from the content, or a number of characters.
FieldKind
What a connection field’s value must be.
LogLevel
How important a log message is. Core shows info and above to the person, and keeps debug and trace for -v and the log file.
Request
Core → plugin.
Response
Plugin → core.

Constants§

ERROR_KINDS
The kinds an error reply may give, from DRE’s error-code registry.