Module sawp_file::format

source ·
Expand description

Format Specification

The format for serializing SAWP API Calls is a series of consecutive self-contained messages.

The messages are of the following msgpack type where N is the total number messages ranging from two to infinity.

messagetypedescription
1intversion number
2..Ncallcall structure fields

Calls are stored in seperate messages to allow for a streaming format. Users do not have to store the entire SAWP “file” into memory. Messages can be parsed asynchronously.

This format is subject to change and other applications should not attempt to parse it. Use this library instead for encoding and decoding instead.

Structs

  • Data
    A chunk of input data to parse.
  • Gap
    Identifies a missing chunk of input data.
  • Reader
    Reads the expected format from a source.
  • Writer
    Writes serialized API calls to a sink.

Enums