sparrow-ipc 0.3.0
Loading...
Searching...
No Matches
sparrow_ipc::deserialization_context Struct Reference

Encapsulates the context required for deserialization. More...

#include <deserialization_context.hpp>

Collaboration diagram for sparrow_ipc::deserialization_context:
[legend]

Public Member Functions

 deserialization_context (const org::apache::arrow::flatbuf::RecordBatch &record_batch, std::span< const uint8_t > body, size_t &buffer_index, size_t &node_index, size_t &variadic_counts_idx)
 

Public Attributes

const org::apache::arrow::flatbuf::RecordBatch & record_batch
 
std::span< const uint8_t > body
 
size_t & buffer_index
 
size_t & node_index
 
size_t & variadic_counts_idx
 

Detailed Description

Encapsulates the context required for deserialization.

This struct groups parameters that represent the current state and source data for the deserialization process.

Parameters
record_batchThe Flatbuffer RecordBatch containing the data.
bodyThe raw byte buffer of the message body.
buffer_indexThe current index into the buffer list of the RecordBatch.
node_indexThis index tracks the FieldNode being processed in the RecordBatch's depth-first traversal. It is advanced for each FieldNode consumed.
variadic_counts_idxThe current index into the list of variadic buffers (used with view data types).

Definition at line 32 of file deserialization_context.hpp.

Constructor & Destructor Documentation

◆ deserialization_context()

sparrow_ipc::deserialization_context::deserialization_context ( const org::apache::arrow::flatbuf::RecordBatch & record_batch,
std::span< const uint8_t > body,
size_t & buffer_index,
size_t & node_index,
size_t & variadic_counts_idx )
inline

Definition at line 40 of file deserialization_context.hpp.

Member Data Documentation

◆ body

std::span<const uint8_t> sparrow_ipc::deserialization_context::body

Definition at line 35 of file deserialization_context.hpp.

◆ buffer_index

size_t& sparrow_ipc::deserialization_context::buffer_index

Definition at line 36 of file deserialization_context.hpp.

◆ node_index

size_t& sparrow_ipc::deserialization_context::node_index

Definition at line 37 of file deserialization_context.hpp.

◆ record_batch

const org::apache::arrow::flatbuf::RecordBatch& sparrow_ipc::deserialization_context::record_batch

Definition at line 34 of file deserialization_context.hpp.

◆ variadic_counts_idx

size_t& sparrow_ipc::deserialization_context::variadic_counts_idx

Definition at line 38 of file deserialization_context.hpp.


The documentation for this struct was generated from the following file: