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

Encapsulates the description of a field to be deserialized. More...

#include <deserialization_context.hpp>

Collaboration diagram for sparrow_ipc::field_descriptor:
[legend]

Public Member Functions

 field_descriptor (int64_t length, std::string name, std::optional< std::vector< sparrow::metadata_pair > > metadata, std::optional< std::unordered_set< sparrow::ArrowFlag > > flags, bool decode_dictionary_indices, const org::apache::arrow::flatbuf::Field &field, const dictionary_cache *dictionaries)
 

Public Attributes

int64_t length
 
std::string name
 
std::optional< std::vector< sparrow::metadata_pair > > metadata
 
std::optional< std::unordered_set< sparrow::ArrowFlag > > flags
 
bool decode_dictionary_indices
 
const org::apache::arrow::flatbuf::Field & field
 
const dictionary_cachedictionaries = nullptr
 

Detailed Description

Encapsulates the description of a field to be deserialized.

This struct groups parameters that describe the specific field that is currently being processed by the deserializer.

Parameters
lengthThe number of elements in the array to deserialize.
nameThe name of the field.
metadataThe metadata associated with the field.
flagsThe flags associated with the field (e.g., nullable, map keys sorted).
decode_dictionary_indicesWhether dictionary-annotated fields should be read from their physical index buffers (true) or interpreted as logical dictionary values (false).
fieldThe Flatbuffer Field object describing the array to deserialize.
dictionariesCache for dictionaries.

Definition at line 69 of file deserialization_context.hpp.

Constructor & Destructor Documentation

◆ field_descriptor()

sparrow_ipc::field_descriptor::field_descriptor ( int64_t length,
std::string name,
std::optional< std::vector< sparrow::metadata_pair > > metadata,
std::optional< std::unordered_set< sparrow::ArrowFlag > > flags,
bool decode_dictionary_indices,
const org::apache::arrow::flatbuf::Field & field,
const dictionary_cache * dictionaries )
inline

Definition at line 79 of file deserialization_context.hpp.

Member Data Documentation

◆ decode_dictionary_indices

bool sparrow_ipc::field_descriptor::decode_dictionary_indices

Definition at line 75 of file deserialization_context.hpp.

◆ dictionaries

const dictionary_cache* sparrow_ipc::field_descriptor::dictionaries = nullptr

Definition at line 77 of file deserialization_context.hpp.

◆ field

const org::apache::arrow::flatbuf::Field& sparrow_ipc::field_descriptor::field

Definition at line 76 of file deserialization_context.hpp.

◆ flags

std::optional<std::unordered_set<sparrow::ArrowFlag> > sparrow_ipc::field_descriptor::flags

Definition at line 74 of file deserialization_context.hpp.

◆ length

int64_t sparrow_ipc::field_descriptor::length

Definition at line 71 of file deserialization_context.hpp.

◆ metadata

std::optional<std::vector<sparrow::metadata_pair> > sparrow_ipc::field_descriptor::metadata

Definition at line 73 of file deserialization_context.hpp.

◆ name

std::string sparrow_ipc::field_descriptor::name

Definition at line 72 of file deserialization_context.hpp.


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