This is an automated email from the ASF dual-hosted git repository.
github-actions[bot] pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-nanoarrow.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 6bf225dd update documentation for tag main
6bf225dd is described below
commit 6bf225dd77988e07f4feda6dc7eddc694370bcf5
Author: GitHub Actions <[email protected]>
AuthorDate: Sun Aug 23 01:54:36 2026 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1172121 -> 1176988 bytes
main/.doctrees/reference/ipc.doctree | Bin 366032 -> 389692 bytes
main/genindex.html | 6 +++--
main/objects.inv | Bin 23037 -> 23152 bytes
main/r/pkgdown.yml | 2 +-
main/reference/ipc.html | 42 +++++++++++++++++++++++++++++++++++
main/searchindex.js | 2 +-
7 files changed, 48 insertions(+), 4 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 7d31f1cf..b018369f 100644
Binary files a/main/.doctrees/environment.pickle and
b/main/.doctrees/environment.pickle differ
diff --git a/main/.doctrees/reference/ipc.doctree
b/main/.doctrees/reference/ipc.doctree
index 51b39c00..06e7ad8e 100644
Binary files a/main/.doctrees/reference/ipc.doctree and
b/main/.doctrees/reference/ipc.doctree differ
diff --git a/main/genindex.html b/main/genindex.html
index 7d8caa2a..2a4dcd7d 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -779,10 +779,10 @@
</li>
<li><a
href="reference/device.html#_CPPv4N16ArrowDeviceArray11device_typeE">ArrowDeviceArray::device_type
(C++ member)</a>
</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/device.html#_CPPv4N16ArrowDeviceArray8reservedE">ArrowDeviceArray::reserved
(C++ member)</a>
</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/device.html#_CPPv4N16ArrowDeviceArray10sync_eventE">ArrowDeviceArray::sync_event
(C++ member)</a>
</li>
<li><a
href="reference/device.html#_CPPv420ArrowDeviceArrayInitP11ArrowDeviceP16ArrowDeviceArrayP10ArrowArrayPv">ArrowDeviceArrayInit
(C++ function)</a>
@@ -962,6 +962,8 @@
<li><a
href="reference/ipc.html#_CPPv4N23ArrowIpcMetadataVersion33NANOARROW_IPC_METADATA_VERSION_V4E">ArrowIpcMetadataVersion::NANOARROW_IPC_METADATA_VERSION_V4
(C++ enumerator)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv4N23ArrowIpcMetadataVersion33NANOARROW_IPC_METADATA_VERSION_V5E">ArrowIpcMetadataVersion::NANOARROW_IPC_METADATA_VERSION_V5
(C++ enumerator)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv429ArrowIpcMetadataVisitFunction">ArrowIpcMetadataVisitFunction
(C++ type)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv420ArrowIpcOutputStream">ArrowIpcOutputStream
(C++ struct)</a>
</li>
diff --git a/main/objects.inv b/main/objects.inv
index fdce729d..d8d2b349 100644
Binary files a/main/objects.inv and b/main/objects.inv differ
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index 0d2b03dd..47ab4bd9 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,4 +2,4 @@ pandoc: 3.7.0.2
pkgdown: 2.2.1
pkgdown_sha: ~
articles: {}
-last_built: 2026-08-22T03:24Z
+last_built: 2026-08-23T01:54Z
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index f0c2a9f9..e639f562 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -436,6 +436,14 @@
<p>For the most common compression type, ZSTD, this function is sufficient to
capture the type of decompression that Arrow IPC requires (i.e., decompression
where the uncompressed size was recorded). For other compression types, it may
be more efficient to implement a full <a class="reference internal"
href="#struct_arrow_ipc_decompressor"><span class="std
std-ref">ArrowIpcDecompressor</span></a>, which allows for persistent
state/allocations between decodes. </p>
</dd></dl>
+<dl class="cpp type">
+<dt class="sig sig-object cpp" id="_CPPv429ArrowIpcMetadataVisitFunction">
+<span id="_CPPv329ArrowIpcMetadataVisitFunction"></span><span
id="_CPPv229ArrowIpcMetadataVisitFunction"></span><span
id="ArrowIpcMetadataVisitFunction"></span><span class="target"
id="group__nanoarrow__ipc_1gab53643878475bfbee2e34a5f11c84034"></span><span
class="k"><span class="pre">typedef</span></span><span class="w"> </span><a
class="reference internal" href="c.html#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span [...]
+<dd><p>Callback invoked for each key/value pair by <a class="reference
internal"
href="#group__nanoarrow__ipc_1ga477ef44368c75aa85e092119dd7d7b70"><span
class="std std-ref">ArrowIpcDecoderVisitMessageMetadata()</span></a>. </p>
+<p>Both key and value are borrowed and are passed with an explicit size
because neither is required to be present nor free of embedded nulls: a key or
value that the message omits is passed as an empty string view.</p>
+<p>Returning any value other than NANOARROW_OK will stop the visit and cause
that value to be returned by <a class="reference internal"
href="#group__nanoarrow__ipc_1ga477ef44368c75aa85e092119dd7d7b70"><span
class="std std-ref">ArrowIpcDecoderVisitMessageMetadata()</span></a>. </p>
+</dd></dl>
+
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-enums">Enums</p>
@@ -719,6 +727,31 @@
<p>Returns EINVAL if the content of the message cannot be decoded or ENOTSUP
if the content of the message uses features not supported by this library. </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow__ipc_1gac6f6e05bf85fea2ed29e726ff3a6273c"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderGetMessageMetadata</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDecoder</span> <span
class="pre">*decoder,</span> <span class="pre">struct</span> <span
class="pre">ArrowBuffer</span> <span class="pre">*out,</span> <span
class="pre">stru [...]
+<dd><p>Get the custom metadata of the most recently decoded message. </p>
+<p>After a successful call to <a class="reference internal"
href="#group__nanoarrow__ipc_1ga44d81881fc64b77af37c3acf30bc6f51"><span
class="std std-ref">ArrowIpcDecoderVerifyHeader()</span></a> or <a
class="reference internal"
href="#group__nanoarrow__ipc_1ga7a0b784166e614901e2818d2a29a95dc"><span
class="std std-ref">ArrowIpcDecoderDecodeHeader()</span></a>, copy the
message’s custom_metadata into out using the same representation as
ArrowSchema::metadata. Note that this is the metadata a [...]
+<p>out is initialized by this call (i.e., it must not contain data) and the
caller is responsible for calling ArrowBufferReset(). If the message had no
custom metadata, out will be empty (i.e., out->data will be NULL) such that
(const char*)out->data can be passed to <a class="reference internal"
href="c.html#group__nanoarrow-schema_1ga1262f80405aae6863bfb2d16175a0796"><span
class="std std-ref">ArrowSchemaSetMetadata()</span></a> or <a class="reference
internal" href="c.html#group_ [...]
+<p>Returns ENOMEM if allocation fails, EINVAL if the metadata cannot be
decoded, or NANOARROW_OK otherwise. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow__ipc_1gac7e768c75054f491be474a461eb09ca8"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderGetMessageMetadataValue</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDecoder</span> <span
class="pre">*decoder,</span> <span class="pre">struct</span> <span
class="pre">ArrowStringView</span> <span class="pre">key,</span> <span class="p
[...]
+<dd><p>Get one value from the custom metadata of the most recently decoded
message. </p>
+<p>Unlike <a class="reference internal"
href="#group__nanoarrow__ipc_1gac6f6e05bf85fea2ed29e726ff3a6273c"><span
class="std std-ref">ArrowIpcDecoderGetMessageMetadata()</span></a>, this does
not copy: the value returned points into the message header passed to <a
class="reference internal"
href="#group__nanoarrow__ipc_1ga44d81881fc64b77af37c3acf30bc6f51"><span
class="std std-ref">ArrowIpcDecoderVerifyHeader()</span></a> or <a
class="reference internal" href="#group__nanoarrow__ipc_1ga7a0b [...]
+<p>If key occurs more than once, the first value is returned. If key does not
occur, value_out is left unmodified: initialize it with ArrowCharView(NULL) and
check value_out->data for NULL to detect a missing key. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow__ipc_1ga477ef44368c75aa85e092119dd7d7b70"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderVisitMessageMetadata</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDecoder</span> <span
class="pre">*decoder,</span> <span
class="pre">ArrowIpcMetadataVisitFunction</span> <span
class="pre">visit,</span> <span class="pre">void</span> <sp [...]
+<dd><p>Visit each key/value pair in the most recently decoded message’s
metadata. </p>
+<p>Like <a class="reference internal"
href="#group__nanoarrow__ipc_1gac7e768c75054f491be474a461eb09ca8"><span
class="std std-ref">ArrowIpcDecoderGetMessageMetadataValue()</span></a>, the
keys and values passed to visit point into the message header passed to <a
class="reference internal"
href="#group__nanoarrow__ipc_1ga44d81881fc64b77af37c3acf30bc6f51"><span
class="std std-ref">ArrowIpcDecoderVerifyHeader()</span></a> or <a
class="reference internal" href="#group__nanoarrow__ipc_1ga7a0b7 [...]
+<p>Returns the first non-NANOARROW_OK value returned by visit, or NANOARROW_OK
if all pairs were visited. </p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp">
<span class="target"
id="group__nanoarrow__ipc_1ga6537fc8201e2db40f973bd98ea609a8d"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderDecodeSchema</span> <span class="pre">(struct</span>
<span class="pre">ArrowIpcDecoder</span> <span class="pre">*decoder,</span>
<span class="pre">struct</span> <span class="pre">ArrowSchema</span> <span
class="pre">*out,</span> <span class="pre">struct</sp [...]
@@ -868,6 +901,14 @@
<p>The bytes of the encoded message will be appended to the provided buffer.
</p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow__ipc_1ga05db635e4c433c34f40e69db45b55e2b"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcEncoderSetMessageMetadata</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcEncoder</span> <span
class="pre">*encoder,</span> <span class="pre">struct</span> <span
class="pre">ArrowBuffer</span> <span class="pre">*metadata,</span> <span
class="pre" [...]
+<dd><p>Set the custom metadata of the next encoded message. </p>
+<p>Attaches metadata to the next message encoded by <a class="reference
internal"
href="#group__nanoarrow__ipc_1gabd2af9c33984ccc5b349b5247ef4655f"><span
class="std std-ref">ArrowIpcEncoderEncodeSchema()</span></a> or <a
class="reference internal"
href="#group__nanoarrow__ipc_1ga08930a86ff9fb73a3e607967c9c84037"><span
class="std std-ref">ArrowIpcEncoderEncodeSimpleRecordBatch()</span></a> (i.e.,
Message::custom_metadata, which is distinct from the metadata of the Schema or
Field that the [...]
+<p>metadata contains the same representation as ArrowSchema::metadata, as
built by <a class="reference internal"
href="c.html#group__nanoarrow-metadata_1gaa5ec9643870d9fc0e55ef78c3a374ec3"><span
class="std
std-ref">ArrowMetadataBuilderInit()</span></a>/ArrowMetadataBuilderAppend().
The encoder takes ownership of it: unless metadata is NULL it is moved into the
encoder and left empty. Metadata containing no keys is equivalent to no
metadata at all and no custom_metadata is encoded for it. </p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp">
<span class="target"
id="group__nanoarrow__ipc_1gabd2af9c33984ccc5b349b5247ef4655f"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcEncoderEncodeSchema</span> <span class="pre">(struct</span>
<span class="pre">ArrowIpcEncoder</span> <span class="pre">*encoder,</span>
<span class="pre">const</span> <span class="pre">struct</span> <span
class="pre">ArrowSchema</span> <span class="pre">*schema,</ [...]
@@ -1393,6 +1434,7 @@
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#c.NANOARROW_IPC_FEATURE_DICTIONARY_REPLACEMENT"><code class="docutils
literal notranslate"><span
class="pre">NANOARROW_IPC_FEATURE_DICTIONARY_REPLACEMENT</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#c.NANOARROW_IPC_FEATURE_COMPRESSED_BODY"><code class="docutils literal
notranslate"><span
class="pre">NANOARROW_IPC_FEATURE_COMPRESSED_BODY</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv426ArrowIpcDecompressFunction"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcDecompressFunction</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv429ArrowIpcMetadataVisitFunction"><code class="docutils literal
notranslate"><span
class="pre">ArrowIpcMetadataVisitFunction</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv423ArrowIpcMetadataVersion"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcMetadataVersion</span></code></a><ul
class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N23ArrowIpcMetadataVersion33NANOARROW_IPC_METADATA_VERSION_V1E"><code
class="docutils literal notranslate"><span
class="pre">NANOARROW_IPC_METADATA_VERSION_V1</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N23ArrowIpcMetadataVersion33NANOARROW_IPC_METADATA_VERSION_V2E"><code
class="docutils literal notranslate"><span
class="pre">NANOARROW_IPC_METADATA_VERSION_V2</span></code></a></li>
diff --git a/main/searchindex.js b/main/searchindex.js
index fda605bc..27ce8fe7 100644
--- a/main/searchindex.js
+++ b/main/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles":{"API Reference":[[8,null]],"Array Stream
utilities":[[6,"array-stream-utilities"]],"Array
Streams":[[3,"array-streams"]],"Array
streams":[[2,"array-streams"]],"Arrays":[[2,"arrays"],[3,"arrays"]],"Arrow C
Data Interface":[[5,"arrow-c-data-interface"]],"Arrow C Device
Interface":[[7,"arrow-c-device-interface"]],"Arrow C data/nanoarrow interface
basics":[[0,"arrow-c-data-nanoarrow-interface-basics"]],"Bitmap
utilities":[[5,"bitmap-utilities"]],"Buffer utilitie [...]
\ No newline at end of file
+Search.setIndex({"alltitles":{"API Reference":[[8,null]],"Array Stream
utilities":[[6,"array-stream-utilities"]],"Array
Streams":[[3,"array-streams"]],"Array
streams":[[2,"array-streams"]],"Arrays":[[2,"arrays"],[3,"arrays"]],"Arrow C
Data Interface":[[5,"arrow-c-data-interface"]],"Arrow C Device
Interface":[[7,"arrow-c-device-interface"]],"Arrow C data/nanoarrow interface
basics":[[0,"arrow-c-data-nanoarrow-interface-basics"]],"Bitmap
utilities":[[5,"bitmap-utilities"]],"Buffer utilitie [...]
\ No newline at end of file
