Enum State

enum State {
    StreamHeader,
    MsgPackMessageHeader,
    MsgPackMessage(LegacyMessageHeader),
    ProtobufMessageHeader,
    ProtobufMessage(MessageHeader),
}

StreamHeader
     |
     v
MessageHeader
^           |
|           |
---Message<--

Variants

StreamHeader

The beginning of the stream.

The stream header contains the magic bytes (e.g. RRF2), the encoded version, and the encoding options.

After the stream header is read once, the state machine will only ever switch between MessageHeader and Message

MsgPackMessageHeader

The beginning of a MsgPack message.

The message header contains the number of bytes in the compressed message, and the number of bytes in the uncompressed message.

MsgPackMessage(LegacyMessageHeader)

The message content, serialized using MsgPack.

We need to know the full length of the message before attempting to read it, otherwise the call to decompress_into or the MsgPack deserialization may block or even fail.

ProtobufMessageHeader

The beginning of a Protobuf message.

ProtobufMessage(MessageHeader)

The message content, serialized using Protobuf.

Compression is only applied to individual ArrowMsgs, instead of the entire stream.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for State

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for State