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 506a105e update documentation for tag main
506a105e is described below
commit 506a105e1960277918d3e36847231e97462a1505
Author: GitHub Actions <[email protected]>
AuthorDate: Thu Aug 15 19:43:34 2024 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1151427 -> 1160774 bytes
main/.doctrees/reference/ipc.doctree | Bin 352661 -> 366305 bytes
main/genindex.html | 10 ++++++++--
main/objects.inv | Bin 17461 -> 17585 bytes
main/r/pkgdown.yml | 2 +-
main/reference/ipc.html | 23 +++++++++++++++++++++++
main/searchindex.js | 2 +-
7 files changed, 33 insertions(+), 4 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 3ea0436d..80db564e 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 6004a407..3fa3f98b 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 e8d46a2b..6287329c 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -681,10 +681,10 @@ document.write(`
</li>
<li><a
href="reference/device.html#_CPPv425ArrowDeviceArrayViewResetP20ArrowDeviceArrayView">ArrowDeviceArrayViewReset
(C++ function)</a>
</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
<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>
<li><a
href="reference/device.html#_CPPv435ArrowDeviceArrayViewSetArrayMinimalP20ArrowDeviceArrayViewP16ArrowDeviceArrayP10ArrowError">ArrowDeviceArrayViewSetArrayMinimal
(C++ function)</a>
@@ -868,10 +868,14 @@ document.write(`
<li><a href="reference/ipc.html#_CPPv414ArrowIpcWriter">ArrowIpcWriter
(C++ struct)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv4N14ArrowIpcWriter12private_dataE">ArrowIpcWriter::private_data
(C++ member)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv426ArrowIpcWriterFinalizeFileP14ArrowIpcWriterP10ArrowError">ArrowIpcWriterFinalizeFile
(C++ function)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv418ArrowIpcWriterInitP14ArrowIpcWriterP20ArrowIpcOutputStream">ArrowIpcWriterInit
(C++ function)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv419ArrowIpcWriterResetP14ArrowIpcWriter">ArrowIpcWriterReset
(C++ function)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv423ArrowIpcWriterStartFileP14ArrowIpcWriterP10ArrowError">ArrowIpcWriterStartFile
(C++ function)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv430ArrowIpcWriterWriteArrayStreamP14ArrowIpcWriterP16ArrowArrayStreamP10ArrowError">ArrowIpcWriterWriteArrayStream
(C++ function)</a>
</li>
@@ -1484,6 +1488,8 @@ document.write(`
<li><a
href="reference/device.html#_CPPv421UniqueDeviceArrayView">UniqueDeviceArrayView
(C++ type)</a>
</li>
<li><a href="reference/ipc.html#_CPPv413UniqueEncoder">UniqueEncoder
(C++ type)</a>
+</li>
+ <li><a href="reference/ipc.html#_CPPv412UniqueFooter">UniqueFooter (C++
type)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv417UniqueInputStream">UniqueInputStream (C++
type)</a>
</li>
diff --git a/main/objects.inv b/main/objects.inv
index f66bed7a..95d94931 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 dd527127..bdb48931 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-12T21:14Z
+last_built: 2024-08-15T19:42Z
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index 7e994f4a..da27a608 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -787,6 +787,20 @@ document.write(`
<p>Errors are propagated from the underlying encoder, array stream, and output
byte stream. </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv423ArrowIpcWriterStartFileP14ArrowIpcWriterP10ArrowError">
+<span
id="_CPPv323ArrowIpcWriterStartFileP14ArrowIpcWriterP10ArrowError"></span><span
id="_CPPv223ArrowIpcWriterStartFileP14ArrowIpcWriterP10ArrowError"></span><span
id="ArrowIpcWriterStartFile__ArrowIpcWriterP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow__ipc_1gaf5898fd271ec76cf56f8d6d55b5521e0"></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">ArrowIpcWriterStar [...]
+<dd><p>Start writing an IPC file. </p>
+<p>Writes the Arrow IPC magic and sets the writer up to track written blocks.
</p>
+</dd></dl>
+
+<dl class="cpp function">
+<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>
+</dd></dl>
+
</div>
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv420ArrowIpcSharedBuffer">
@@ -997,6 +1011,12 @@ document.write(`
<dd><p>Class wrapping a unique struct <a class="reference internal"
href="#struct_arrow_ipc_decoder"><span class="std
std-ref">ArrowIpcDecoder</span></a>. </p>
</dd></dl>
+<dl class="cpp type">
+<dt class="sig sig-object cpp" id="_CPPv412UniqueFooter">
+<span id="_CPPv312UniqueFooter"></span><span
id="_CPPv212UniqueFooter"></span><span class="target"
id="group__nanoarrow__ipc__hpp-unique_1gac08aad661c0ba6d741b72b438bfa40d6"></span><span
class="k"><span class="pre">using</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">UniqueFooter</span></span></span><span class="w"> </span><span
class="p"><span class="pre">=</span></span><span class="w"> </span><span
class="n"><span class="pre">inte [...]
+<dd><p>Class wrapping a unique struct ArrowIpcFooter. </p>
+</dd></dl>
+
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv413UniqueEncoder">
<span id="_CPPv313UniqueEncoder"></span><span
id="_CPPv213UniqueEncoder"></span><span class="target"
id="group__nanoarrow__ipc__hpp-unique_1ga7d8001dff97da64dce4f8a13521bbaa5"></span><span
class="k"><span class="pre">using</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">UniqueEncoder</span></span></span><span class="w"> </span><span
class="p"><span class="pre">=</span></span><span class="w"> </span><span
class="n"><span class="pre">i [...]
@@ -1137,6 +1157,8 @@ document.write(`
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv425ArrowIpcWriterWriteSchemaP14ArrowIpcWriterPK11ArrowSchemaP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcWriterWriteSchema()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv428ArrowIpcWriterWriteArrayViewP14ArrowIpcWriterPK14ArrowArrayViewP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcWriterWriteArrayView()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv430ArrowIpcWriterWriteArrayStreamP14ArrowIpcWriterP16ArrowArrayStreamP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcWriterWriteArrayStream()</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="#_CPPv426ArrowIpcWriterFinalizeFileP14ArrowIpcWriterP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcWriterFinalizeFile()</span></code></a></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="#_CPPv415ArrowIpcDecoder"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcDecoder</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="#_CPPv4N15ArrowIpcDecoder12message_typeE"><code class="docutils literal
notranslate"><span
class="pre">ArrowIpcDecoder::message_type</span></code></a></li>
@@ -1178,6 +1200,7 @@ document.write(`
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link"
href="#c-helpers">C++ Helpers</a><ul class="visible nav section-nav
flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv413UniqueDecoder"><code class="docutils literal notranslate"><span
class="pre">UniqueDecoder</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv412UniqueFooter"><code class="docutils literal notranslate"><span
class="pre">UniqueFooter</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv413UniqueEncoder"><code class="docutils literal notranslate"><span
class="pre">UniqueEncoder</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv417UniqueInputStream"><code class="docutils literal
notranslate"><span class="pre">UniqueInputStream</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv418UniqueOutputStream"><code class="docutils literal
notranslate"><span class="pre">UniqueOutputStream</span></code></a></li>
diff --git a/main/searchindex.js b/main/searchindex.js
index 257d4f04..d69faced 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
