This is an automated email from the ASF dual-hosted git repository.
github-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 a3798652 update documentation for tag main
a3798652 is described below
commit a37986529485fa7861facc3f23e939ce3fbc8293
Author: GitHub Actions <[email protected]>
AuthorDate: Fri Mar 6 14:47:44 2026 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1149644 -> 1155471 bytes
main/.doctrees/reference/ipc.doctree | Bin 293763 -> 303291 bytes
main/genindex.html | 12 ++++++++++--
main/objects.inv | Bin 22193 -> 22361 bytes
main/r/pkgdown.yml | 2 +-
main/reference/ipc.html | 35 +++++++++++++++++++++++++++++++++++
main/searchindex.js | 2 +-
7 files changed, 47 insertions(+), 4 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 47299cb7..4e32945a 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 3cd42b06..ac2bf21c 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 67c19433..7bafee13 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -746,12 +746,12 @@
</li>
<li><a
href="reference/device.html#_CPPv4N11ArrowDevice12private_dataE">ArrowDevice::private_data
(C++ member)</a>
</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/device.html#_CPPv4N11ArrowDevice7releaseE">ArrowDevice::release
(C++ member)</a>
</li>
<li><a
href="reference/device.html#_CPPv4N11ArrowDevice17synchronize_eventE">ArrowDevice::synchronize_event
(C++ member)</a>
</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/device.html#_CPPv416ArrowDeviceArray">ArrowDeviceArray (C++
struct)</a>
</li>
<li><a
href="reference/device.html#_CPPv4N16ArrowDeviceArray5arrayE">ArrowDeviceArray::array
(C++ member)</a>
@@ -843,6 +843,8 @@
<li><a
href="reference/ipc.html#_CPPv4N15ArrowIpcDecoder15body_size_bytesE">ArrowIpcDecoder::body_size_bytes
(C++ member)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv4N15ArrowIpcDecoder5codecE">ArrowIpcDecoder::codec
(C++ member)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv4N15ArrowIpcDecoder10dictionaryE">ArrowIpcDecoder::dictionary
(C++ member)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv4N15ArrowIpcDecoder10endiannessE">ArrowIpcDecoder::endianness
(C++ member)</a>
</li>
@@ -869,6 +871,12 @@
<li><a
href="reference/ipc.html#_CPPv4N20ArrowIpcDecompressor12private_dataE">ArrowIpcDecompressor::private_data
(C++ member)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv4N20ArrowIpcDecompressor7releaseE">ArrowIpcDecompressor::release
(C++ member)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv423ArrowIpcDictionaryBatch">ArrowIpcDictionaryBatch
(C++ struct)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv4N23ArrowIpcDictionaryBatch2idE">ArrowIpcDictionaryBatch::id
(C++ member)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv4N23ArrowIpcDictionaryBatch8is_deltaE">ArrowIpcDictionaryBatch::is_delta
(C++ member)</a>
</li>
<li><a href="reference/ipc.html#_CPPv415ArrowIpcEncoder">ArrowIpcEncoder
(C++ struct)</a>
</li>
diff --git a/main/objects.inv b/main/objects.inv
index a6888c44..72de66e3 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 51ef5c07..446dbc18 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,4 +2,4 @@ pandoc: 3.1.3
pkgdown: 2.2.0
pkgdown_sha: ~
articles: {}
-last_built: 2026-03-06T14:43Z
+last_built: 2026-03-06T14:47Z
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index f6677a8d..b455239f 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -822,6 +822,29 @@
</dd></dl>
</div>
+<dl class="cpp struct">
+<dt class="sig sig-object cpp" id="_CPPv423ArrowIpcDictionaryBatch">
+<span id="_CPPv323ArrowIpcDictionaryBatch"></span><span
id="_CPPv223ArrowIpcDictionaryBatch"></span><span
id="ArrowIpcDictionaryBatch"></span><span class="target"
id="struct_arrow_ipc_dictionary_batch"></span><span class="k"><span
class="pre">struct</span></span><span class="w"> </span><span class="sig-name
descname"><span class="n"><span
class="pre">ArrowIpcDictionaryBatch</span></span></span><a class="headerlink"
href="#_CPPv423ArrowIpcDictionaryBatch" title="Link to this definition"># [...]
+<dd><div class="docutils container">
+<em>#include <nanoarrow_ipc.h></em></div>
+<p>Description of an Arrow IPC DictionaryBatch message. </p>
+<div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-public-members">Public Members</p>
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N23ArrowIpcDictionaryBatch2idE">
+<span id="_CPPv3N23ArrowIpcDictionaryBatch2idE"></span><span
id="_CPPv2N23ArrowIpcDictionaryBatch2idE"></span><span
id="ArrowIpcDictionaryBatch::id__int64_t"></span><span class="target"
id="struct_arrow_ipc_dictionary_batch_1a5b5c3f2d0eadcd70117ad9488dd916c6"></span><span
class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">id</span></span></span><a class="headerlink"
href="#_CPPv4N23ArrowIpcDictionaryB [...]
+<dd><p>The identifier for this dictionary. </p>
+</dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N23ArrowIpcDictionaryBatch8is_deltaE">
+<span id="_CPPv3N23ArrowIpcDictionaryBatch8is_deltaE"></span><span
id="_CPPv2N23ArrowIpcDictionaryBatch8is_deltaE"></span><span
id="ArrowIpcDictionaryBatch::is_delta__i"></span><span class="target"
id="struct_arrow_ipc_dictionary_batch_1a239885a6ae7913085991afe27dff7d82"></span><span
class="kt"><span class="pre">int</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">is_delta</span></span></span><a class="headerlink"
href="#_CPPv4N23Arro [...]
+<dd><p>If non-zero, values should be appended to the existing dictionary.
Otherwise, values should replace the existing dictionary. </p>
+</dd></dl>
+
+</div>
+</dd></dl>
+
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv420ArrowIpcSharedBuffer">
<span id="_CPPv320ArrowIpcSharedBuffer"></span><span
id="_CPPv220ArrowIpcSharedBuffer"></span><span
id="ArrowIpcSharedBuffer"></span><span class="target"
id="struct_arrow_ipc_shared_buffer"></span><span class="k"><span
class="pre">struct</span></span><span class="w"> </span><span class="sig-name
descname"><span class="n"><span
class="pre">ArrowIpcSharedBuffer</span></span></span><a class="headerlink"
href="#_CPPv420ArrowIpcSharedBuffer" title="Link to this definition">#</a><br
/></dt>
@@ -921,6 +944,12 @@
<dd><p>The number of bytes in the forthcoming body message. </p>
</dd></dl>
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N15ArrowIpcDecoder10dictionaryE">
+<span id="_CPPv3N15ArrowIpcDecoder10dictionaryE"></span><span
id="_CPPv2N15ArrowIpcDecoder10dictionaryE"></span><span
id="ArrowIpcDecoder::dictionary__ArrowIpcDictionaryBatchCP"></span><span
class="target"
id="struct_arrow_ipc_decoder_1a4387bdf8ec18876581210ec2fed48703"></span><span
class="k"><span class="pre">const</span></span><span class="w"> </span><span
class="k"><span class="pre">struct</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv423ArrowIpcDictio [...]
+<dd><p>The last decoded DictionaryBatch. </p>
+</dd></dl>
+
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N15ArrowIpcDecoder6footerE">
<span id="_CPPv3N15ArrowIpcDecoder6footerE"></span><span
id="_CPPv2N15ArrowIpcDecoder6footerE"></span><span
id="ArrowIpcDecoder::footer__ArrowIpcFooterP"></span><span class="target"
id="struct_arrow_ipc_decoder_1ab315f7523d1b09f0575ba5fc3afbdd96"></span><span
class="k"><span class="pre">struct</span></span><span class="w"> </span><span
class="n"><span class="pre">ArrowIpcFooter</span></span><span class="w">
</span><span class="p"><span class="pre">*</span></span><span class="sig-name
des [...]
@@ -1210,6 +1239,11 @@
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv424ArrowIpcSystemEndiannessv"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcSystemEndianness()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv423ArrowIpcWriterStartFileP14ArrowIpcWriterP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcWriterStartFile()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv423ArrowIpcDictionaryBatch"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcDictionaryBatch</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="#_CPPv4N23ArrowIpcDictionaryBatch2idE"><code class="docutils literal
notranslate"><span class="pre">id</span></code></a></li>
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N23ArrowIpcDictionaryBatch8is_deltaE"><code class="docutils
literal notranslate"><span class="pre">is_delta</span></code></a></li>
+</ul>
+</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv420ArrowIpcSharedBuffer"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcSharedBuffer</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv420ArrowIpcDecompressor"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcDecompressor</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="#_CPPv4N20ArrowIpcDecompressor14decompress_addE"><code class="docutils
literal notranslate"><span class="pre">decompress_add</span></code></a></li>
@@ -1226,6 +1260,7 @@
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N15ArrowIpcDecoder5codecE"><code class="docutils literal
notranslate"><span class="pre">codec</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N15ArrowIpcDecoder17header_size_bytesE"><code class="docutils
literal notranslate"><span class="pre">header_size_bytes</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N15ArrowIpcDecoder15body_size_bytesE"><code class="docutils
literal notranslate"><span class="pre">body_size_bytes</span></code></a></li>
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N15ArrowIpcDecoder10dictionaryE"><code class="docutils literal
notranslate"><span class="pre">dictionary</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N15ArrowIpcDecoder6footerE"><code class="docutils literal
notranslate"><span class="pre">footer</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N15ArrowIpcDecoder12private_dataE"><code class="docutils literal
notranslate"><span class="pre">private_data</span></code></a></li>
</ul>
diff --git a/main/searchindex.js b/main/searchindex.js
index 26ba738a..911ccf94 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
