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 da0853d3 update documentation for tag main
da0853d3 is described below
commit da0853d3abe6452e1c683c48543a7b212f23cb04
Author: GitHub Actions <[email protected]>
AuthorDate: Thu Sep 10 17:42:33 2026 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1200915 -> 1200774 bytes
main/.doctrees/reference/ipc.doctree | Bin 464836 -> 462323 bytes
main/genindex.html | 4 ++--
main/objects.inv | Bin 23705 -> 23690 bytes
main/r/pkgdown.yml | 2 +-
main/reference/ipc.html | 23 ++++++++---------------
main/searchindex.js | 2 +-
7 files changed, 12 insertions(+), 19 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 3a4f89a7..1f0db8b3 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 e92b35c9..9ce7be2f 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 d640e915..8227edda 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -950,6 +950,8 @@
<li><a
href="reference/ipc.html#_CPPv4N19ArrowIpcInputStream4readE">ArrowIpcInputStream::read
(C++ member)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv4N19ArrowIpcInputStream7releaseE">ArrowIpcInputStream::release
(C++ member)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv436ArrowIpcMessageMetadataVisitFunction">ArrowIpcMessageMetadataVisitFunction
(C++ type)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv419ArrowIpcMessageType">ArrowIpcMessageType (C++
enum)</a>
</li>
@@ -976,8 +978,6 @@
<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 7b3ebfc9..d9f793cf 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 c76ff457..5c5e956f 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-09-09T17:14Z
+last_built: 2026-09-10T17:42Z
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index 7cea820a..83883a25 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -451,11 +451,11 @@
</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>
+<dt class="sig sig-object cpp"
id="_CPPv436ArrowIpcMessageMetadataVisitFunction">
+<span id="_CPPv336ArrowIpcMessageMetadataVisitFunction"></span><span
id="_CPPv236ArrowIpcMessageMetadataVisitFunction"></span><span
id="ArrowIpcMessageMetadataVisitFunction"></span><span class="target"
id="group__nanoarrow__ipc_1gac9e301a40d4f45841dec5aa0bb42ad71"></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</s [...]
+<dd><p>Callback invoked for each key/value pair by <a class="reference
internal"
href="#group__nanoarrow__ipc_1gac0f4a44a29b4244a63b6de69dc2f3fd7"><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>
+<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_1gac0f4a44a29b4244a63b6de69dc2f3fd7"><span
class="std std-ref">ArrowIpcDecoderVisitMessageMetadata()</span></a>. </p>
</dd></dl>
</div>
@@ -796,22 +796,15 @@
<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>To read a single key, pass (const char*)out->data to <a class="reference
internal"
href="c.html#group__nanoarrow-metadata_1gae6046e52178a8bd37c98a59b7fa57059"><span
class="std std-ref">ArrowMetadataGetValue()</span></a>; to read every pair
without copying, use <a class="reference internal"
href="#group__nanoarrow__ipc_1gac0f4a44a29b4244a63b6de69dc2f3fd7"><span
class="std std-ref">ArrowIpcDecoderVisitMessageMetadata()</span></a>.</p>
<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 [...]
+<span class="target"
id="group__nanoarrow__ipc_1gac0f4a44a29b4244a63b6de69dc2f3fd7"></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">ArrowIpcMessageMetadataVisitFunction</span> <span
class="pre">visit,</span> <span class="pre">void</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>Unlike <a class="reference internal"
href="#group__nanoarrow__ipc_1gac6f6e05bf85fea2ed29e726ff3a6273c"><span
class="std std-ref">ArrowIpcDecoderGetMessageMetadata()</span></a>, this does
not copy: 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__nanoar [...]
<p>Returns the first non-NANOARROW_OK value returned by visit, or NANOARROW_OK
if all pairs were visited. </p>
</dd></dl>
@@ -1592,7 +1585,7 @@
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#c.NANOARROW_IPC_COMPRESSION_LEVEL_DEFAULT"><code class="docutils literal
notranslate"><span
class="pre">NANOARROW_IPC_COMPRESSION_LEVEL_DEFAULT</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="#_CPPv424ArrowIpcCompressFunction"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcCompressFunction</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="#_CPPv436ArrowIpcMessageMetadataVisitFunction"><code class="docutils
literal notranslate"><span
class="pre">ArrowIpcMessageMetadataVisitFunction</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 cadd8068..2878ae57 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
