|
11 | 11 |
|
12 | 12 | namespace sparrow_ipc |
13 | 13 | { |
14 | | - /** |
15 | | - * @brief Deserializes a schema message from Arrow IPC format data. |
16 | | - * |
17 | | - * This function parses an Arrow IPC schema message from a byte buffer, extracting |
18 | | - * the field name and custom metadata from the first (and expected only) field in the schema. |
19 | | - * |
20 | | - * @param data A span containing the raw byte data to deserialize from |
21 | | - * @param current_offset Reference to the current position in the data buffer, which will be |
22 | | - * updated to point past the processed schema message |
23 | | - * @param name Optional output parameter that will contain the field name if present |
24 | | - * @param metadata Optional output parameter that will contain the custom metadata |
25 | | - * key-value pairs if present |
26 | | - * |
27 | | - * @throws std::runtime_error If the message is not a Schema message type |
28 | | - * @throws std::runtime_error If the schema does not contain exactly one field |
29 | | - * |
30 | | - * @note This function expects the data to start with a 4-byte length prefix followed |
31 | | - * by the FlatBuffer schema message data |
32 | | - */ |
33 | | - SPARROW_IPC_API void deserialize_schema_message( |
34 | | - std::span<const uint8_t> data, |
35 | | - size_t& current_offset, |
36 | | - std::optional<std::string>& name, |
37 | | - std::optional<std::vector<sparrow::metadata_pair>>& metadata |
38 | | - ); |
39 | | - [[nodiscard]] SPARROW_IPC_API const org::apache::arrow::flatbuf::RecordBatch* |
40 | | - deserialize_record_batch_message(std::span<const uint8_t> data, size_t& current_offset); |
41 | | - |
42 | 14 | /** |
43 | 15 | * @brief Deserializes an Arrow IPC stream from binary data into a vector of record batches. |
44 | 16 | * |
|
0 commit comments