Module message 

A serialized sequence of arrays, each with its buffers.

message.fbs:

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright the Vortex contributors

include "vortex-array/array.fbs";
include "vortex-dtype/dtype.fbs";

enum MessageVersion: uint8 {
    V0 = 0,
}

/// Indicates the message body contains a flatbuffer Array message, followed by array buffers.
table ArrayMessage {
    /// The row count of the array.
    row_count: uint32;
    /// The encodings referenced by the array.
    encodings: [string];
}

/// Indicates the body contains a regular byte buffer.
table BufferMessage {
    alignment_exponent: uint8;
}

/// Indicates the body contains a flatbuffer DType message.
table DTypeMessage {}

union MessageHeader {
    ArrayMessage,
    BufferMessage,
    DTypeMessage,
}

table Message {
    version: MessageVersion = V0;
    header: MessageHeader;
    body_size: uint64;
}

root_type Message;

Structs

ArrayMessage

Indicates the message body contains a flatbuffer Array message, followed by array buffers.

ArrayMessageArgs

ArrayMessageBuilder

BufferMessage

Indicates the body contains a regular byte buffer.

BufferMessageArgs

BufferMessageBuilder

DTypeMessage

Indicates the body contains a flatbuffer DType message.

DTypeMessageArgs

DTypeMessageBuilder

Message

MessageArgs

MessageBuilder

MessageHeader

MessageHeaderUnionTableOffset

MessageVersion

Enums

ArrayMessageOffset

BufferMessageOffset

DTypeMessageOffset

MessageOffset

Constants

ENUM_MAX_MESSAGE_HEADERDeprecated

ENUM_MAX_MESSAGE_VERSIONDeprecated

ENUM_MIN_MESSAGE_HEADERDeprecated

ENUM_MIN_MESSAGE_VERSIONDeprecated

ENUM_VALUES_MESSAGE_HEADERDeprecated

ENUM_VALUES_MESSAGE_VERSIONDeprecated

Functions

finish_message_buffer

finish_size_prefixed_message_buffer

root_as_message

Verifies that a buffer of bytes contains a Message and returns it. Note that verification is still experimental and may not catch every error, or be maximally performant. For the previous, unchecked, behavior use root_as_message_unchecked.

root_as_message_unchecked^⚠

Assumes, without verification, that a buffer of bytes contains a Message and returns it.

root_as_message_with_opts

Verifies, with the given options, that a buffer of bytes contains a Message and returns it. Note that verification is still experimental and may not catch every error, or be maximally performant. For the previous, unchecked, behavior use root_as_message_unchecked.

size_prefixed_root_as_message

Verifies that a buffer of bytes contains a size prefixed Message and returns it. Note that verification is still experimental and may not catch every error, or be maximally performant. For the previous, unchecked, behavior use size_prefixed_root_as_message_unchecked.

size_prefixed_root_as_message_unchecked^⚠

Assumes, without verification, that a buffer of bytes contains a size prefixed Message and returns it.

size_prefixed_root_as_message_with_opts

Verifies, with the given verifier options, that a buffer of bytes contains a size prefixed Message and returns it. Note that verification is still experimental and may not catch every error, or be maximally performant. For the previous, unchecked, behavior use root_as_message_unchecked.