This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-nanoarrow.git
The following commit(s) were added to refs/heads/main by this push:
new 43e2093 ipc: Update dist/ for commit
9b034ad916eceec4e9d8300633d0b65687d25511
43e2093 is described below
commit 43e2093a682cadb5801a4fa1b90aca77ac65ccb6
Author: GitHub Actions <[email protected]>
AuthorDate: Fri Apr 21 19:36:12 2023 +0000
ipc: Update dist/ for commit 9b034ad916eceec4e9d8300633d0b65687d25511
---
dist/nanoarrow_ipc.h | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/dist/nanoarrow_ipc.h b/dist/nanoarrow_ipc.h
index 85a765a..5747cec 100644
--- a/dist/nanoarrow_ipc.h
+++ b/dist/nanoarrow_ipc.h
@@ -64,6 +64,18 @@
extern "C" {
#endif
+/// \defgroup nanoarrow_ipc Nanoarrow IPC extension
+///
+/// Except where noted, objects are not thread-safe and clients should
+/// take care to serialize accesses to methods.
+///
+/// Because this library is intended to be vendored, it provides full type
+/// definitions and encourages clients to stack or statically allocate
+/// where convenient.
+///
+/// @{
+
+/// \brief Metadata version enumerator
enum ArrowIpcMetadataVersion {
NANOARROW_IPC_METADATA_VERSION_V1,
NANOARROW_IPC_METADATA_VERSION_V2,
@@ -72,6 +84,7 @@ enum ArrowIpcMetadataVersion {
NANOARROW_IPC_METADATA_VERSION_V5
};
+/// \brief Message type enumerator
enum ArrowIpcMessageType {
NANOARROW_IPC_MESSAGE_TYPE_UNINITIALIZED,
NANOARROW_IPC_MESSAGE_TYPE_SCHEMA,
@@ -81,19 +94,24 @@ enum ArrowIpcMessageType {
NANOARROW_IPC_MESSAGE_TYPE_SPARSE_TENSOR
};
+/// \brief Endianness enumerator
enum ArrowIpcEndianness {
NANOARROW_IPC_ENDIANNESS_UNINITIALIZED,
NANOARROW_IPC_ENDIANNESS_LITTLE,
NANOARROW_IPC_ENDIANNESS_BIG
};
+/// \brief Compression type enumerator
enum ArrowIpcCompressionType {
NANOARROW_IPC_COMPRESSION_TYPE_NONE,
NANOARROW_IPC_COMPRESSION_TYPE_LZ4_FRAME,
NANOARROW_IPC_COMPRESSION_TYPE_ZSTD
};
+/// \brief Feature flag for a stream that uses dictionary replacement
#define NANOARROW_IPC_FEATURE_DICTIONARY_REPLACEMENT 1
+
+/// \brief Feature flag for a stream that uses compression
#define NANOARROW_IPC_FEATURE_COMPRESSED_BODY 2
/// \brief Checks the nanoarrow runtime to make sure the run/build versions
match
@@ -352,6 +370,8 @@ ArrowErrorCode ArrowIpcArrayStreamReaderInit(
struct ArrowArrayStream* out, struct ArrowIpcInputStream* input_stream,
struct ArrowIpcArrayStreamReaderOptions* options);
+/// @}
+
#ifdef __cplusplus
}
#endif
