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 52ff5595 update documentation for tag main
52ff5595 is described below
commit 52ff559585ac2d6d681cac661c386d9534781818
Author: GitHub Actions <[email protected]>
AuthorDate: Fri Aug 30 19:25:35 2024 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1160774 -> 1162388 bytes
main/.doctrees/reference/ipc.doctree | Bin 366305 -> 369204 bytes
main/genindex.html | 6 ++++--
main/objects.inv | Bin 17585 -> 17622 bytes
main/r/pkgdown.yml | 2 +-
main/reference/ipc.html | 13 ++++++++++++-
main/searchindex.js | 2 +-
7 files changed, 18 insertions(+), 5 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 114f4b03..e06d4688 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 3fa3f98b..24fb3f25 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 6287329c..e03ec806 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -683,10 +683,10 @@ document.write(`
</li>
<li><a
href="reference/device.html#_CPPv428ArrowDeviceArrayViewSetArrayP20ArrowDeviceArrayViewP16ArrowDeviceArrayP10ArrowError">ArrowDeviceArrayViewSetArray
(C++ function)</a>
</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/device.html#_CPPv433ArrowDeviceArrayViewSetArrayAsyncP20ArrowDeviceArrayViewP16ArrowDeviceArrayPvP10ArrowError">ArrowDeviceArrayViewSetArrayAsync
(C++ function)</a>
</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/device.html#_CPPv435ArrowDeviceArrayViewSetArrayMinimalP20ArrowDeviceArrayViewP16ArrowDeviceArrayP10ArrowError">ArrowDeviceArrayViewSetArrayMinimal
(C++ function)</a>
</li>
<li><a
href="reference/device.html#_CPPv431ArrowDeviceBasicArrayStreamInitP22ArrowDeviceArrayStreamP16ArrowArrayStreamP11ArrowDevice">ArrowDeviceBasicArrayStreamInit
(C++ function)</a>
@@ -746,6 +746,8 @@ document.write(`
<li><a
href="reference/ipc.html#_CPPv4N15ArrowIpcDecoder10endiannessE">ArrowIpcDecoder::endianness
(C++ member)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv4N15ArrowIpcDecoder13feature_flagsE">ArrowIpcDecoder::feature_flags
(C++ member)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv4N15ArrowIpcDecoder6footerE">ArrowIpcDecoder::footer
(C++ member)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv4N15ArrowIpcDecoder17header_size_bytesE">ArrowIpcDecoder::header_size_bytes
(C++ member)</a>
</li>
diff --git a/main/objects.inv b/main/objects.inv
index 95d94931..f0991652 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 46c40000..9b1cdc32 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,4 +2,4 @@ pandoc: 3.1.3
pkgdown: 2.1.0
pkgdown_sha: ~
articles: {}
-last_built: 2024-08-27T16:18Z
+last_built: 2024-08-30T19:25Z
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index da27a608..b327778b 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -798,7 +798,7 @@ document.write(`
<dt class="sig sig-object cpp"
id="_CPPv426ArrowIpcWriterFinalizeFileP14ArrowIpcWriterP10ArrowError">
<span
id="_CPPv326ArrowIpcWriterFinalizeFileP14ArrowIpcWriterP10ArrowError"></span><span
id="_CPPv226ArrowIpcWriterFinalizeFileP14ArrowIpcWriterP10ArrowError"></span><span
id="ArrowIpcWriterFinalizeFile__ArrowIpcWriterP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow__ipc_1gade66ef48f224e45ac2f292452417c9c1"></span><span
class="n"><span class="pre">ArrowErrorCode</span></span><span class="w">
</span><span class="sig-name descname"><span class="n"><span
class="pre">ArrowIpcW [...]
<dd><p>Finish writing an IPC file. </p>
-<p>Writes the IPC file’s Footer, footer size, and ending magic. </p>
+<p>Writes the IPC file’s footer, footer size, and ending magic. </p>
</dd></dl>
</div>
@@ -862,6 +862,16 @@ document.write(`
<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="_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 [...]
+<dd><p>The last decoded Footer. </p>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<p>This API is currently only public for use in integration testing; use at
your own risk. </p>
+</div>
+</dd></dl>
+
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N15ArrowIpcDecoder12private_dataE">
<span id="_CPPv3N15ArrowIpcDecoder12private_dataE"></span><span
id="_CPPv2N15ArrowIpcDecoder12private_dataE"></span><span
id="ArrowIpcDecoder::private_data__voidP"></span><span class="target"
id="struct_arrow_ipc_decoder_1a9f4ddcdfde8249f3597fa0347189d399"></span><span
class="kt"><span class="pre">void</span></span><span class="w"> </span><span
class="p"><span class="pre">*</span></span><span class="sig-name
descname"><span class="n"><span class="pre">private_data</span></span></span><a
[...]
@@ -1168,6 +1178,7 @@ document.write(`
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N15ArrowIpcDecoder5codecE"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcDecoder::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">ArrowIpcDecoder::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">ArrowIpcDecoder::body_size_bytes</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">ArrowIpcDecoder::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">ArrowIpcDecoder::private_data</span></code></a></li>
</ul>
</li>
diff --git a/main/searchindex.js b/main/searchindex.js
index d69faced..13fa5de4 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-
[...]
\ 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-
[...]
\ No newline at end of file
