Module Message

Structs

• BodyCompression
  Optional compression for the memory buffers constituting IPC message bodies. Intended for use with RecordBatch but could be used for other message types
• BodyCompressionArgs
• BodyCompressionBuilder
• BodyCompressionMethod
  Provided for forward compatibility in case we need to support different strategies for compressing the IPC message body (like whole-body compression rather than buffer-level) in the future
• CompressionType
• DictionaryBatch
  For sending dictionary encoding information. Any Field can be dictionary-encoded, but in this case none of its children may be dictionary-encoded. There is one vector / column per dictionary, but that vector / column may be spread across multiple dictionary batches by using the isDelta flag
• DictionaryBatchArgs
• DictionaryBatchBuilder
• FieldNode

  ---

• Message
• MessageArgs
• MessageBuilder
• MessageHeader

  ---

• MessageHeaderUnionTableOffset
• RecordBatch
  A data header describing the shared memory layout of a “record” or “row” batch. Some systems call this a “row batch” internally and others a “record batch”.
• RecordBatchArgs
• RecordBatchBuilder

Enums

• BodyCompressionOffset
• DictionaryBatchOffset
• MessageOffset
• RecordBatchOffset

Constants

• ENUM_MAX_BODY_COMPRESSION_METHODDeprecated
• ENUM_MAX_COMPRESSION_TYPEDeprecated
• ENUM_MAX_MESSAGE_HEADERDeprecated
• ENUM_MIN_BODY_COMPRESSION_METHODDeprecated
• ENUM_MIN_COMPRESSION_TYPEDeprecated
• ENUM_MIN_MESSAGE_HEADERDeprecated
• ENUM_VALUES_BODY_COMPRESSION_METHODDeprecated
• ENUM_VALUES_COMPRESSION_TYPEDeprecated
• ENUM_VALUES_MESSAGE_HEADERDeprecated

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.