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 70e93cf1 update documentation for tag main
70e93cf1 is described below
commit 70e93cf19551cedfa509a6c33280f66796065cd6
Author: GitHub Actions <[email protected]>
AuthorDate: Wed Jul 31 01:13:47 2024 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1092323 -> 1097552 bytes
main/.doctrees/reference/ipc.doctree | Bin 275093 -> 282106 bytes
main/genindex.html | 8 +++++---
main/objects.inv | Bin 16615 -> 16727 bytes
main/r/pkgdown.yml | 2 +-
main/reference/ipc.html | 17 +++++++++++++----
main/searchindex.js | 2 +-
7 files changed, 20 insertions(+), 9 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index d2ea70ce..694e6f85 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 c353ce9e..c0f78a7b 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 a8029851..0a381196 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -667,10 +667,10 @@ document.write(`
</li>
<li><a
href="reference/device.html#_CPPv4N22ArrowDeviceArrayStream12private_dataE">ArrowDeviceArrayStream::private_data
(C++ member)</a>
</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/device.html#_CPPv4N22ArrowDeviceArrayStream7releaseE">ArrowDeviceArrayStream::release
(C++ member)</a>
</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/device.html#_CPPv420ArrowDeviceArrayView">ArrowDeviceArrayView
(C++ struct)</a>
</li>
<li><a
href="reference/device.html#_CPPv424ArrowDeviceArrayViewCopyP20ArrowDeviceArrayViewP11ArrowDeviceP16ArrowDeviceArray">ArrowDeviceArrayViewCopy
(C++ function)</a>
@@ -787,7 +787,9 @@ document.write(`
</li>
<li><a
href="reference/ipc.html#_CPPv4N15ArrowIpcEncoder12private_dataE">ArrowIpcEncoder::private_data
(C++ member)</a>
</li>
- <li><a
href="reference/ipc.html#_CPPv429ArrowIpcEncoderFinalizeBufferP15ArrowIpcEncoderP11ArrowBuffer">ArrowIpcEncoderFinalizeBuffer
(C++ function)</a>
+ <li><a
href="reference/ipc.html#_CPPv427ArrowIpcEncoderEncodeSchemaP15ArrowIpcEncoderPK11ArrowSchemaP10ArrowError">ArrowIpcEncoderEncodeSchema
(C++ function)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv429ArrowIpcEncoderFinalizeBufferP15ArrowIpcEncodercP11ArrowBuffer">ArrowIpcEncoderFinalizeBuffer
(C++ function)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv419ArrowIpcEncoderInitP15ArrowIpcEncoder">ArrowIpcEncoderInit
(C++ function)</a>
</li>
diff --git a/main/objects.inv b/main/objects.inv
index 6c0ed590..626c8ebb 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 1359c400..52afdae4 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-07-25T15:18Z
+last_built: 2024-07-31T01:13Z
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index ccd13b32..05209927 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -703,12 +703,20 @@ document.write(`
</dd></dl>
<dl class="cpp function">
-<dt class="sig sig-object cpp"
id="_CPPv429ArrowIpcEncoderFinalizeBufferP15ArrowIpcEncoderP11ArrowBuffer">
-<span
id="_CPPv329ArrowIpcEncoderFinalizeBufferP15ArrowIpcEncoderP11ArrowBuffer"></span><span
id="_CPPv229ArrowIpcEncoderFinalizeBufferP15ArrowIpcEncoderP11ArrowBuffer"></span><span
id="ArrowIpcEncoderFinalizeBuffer__ArrowIpcEncoderP.ArrowBufferP"></span><span
class="target"
id="group__nanoarrow__ipc_1gae7799f65e3b74bbf2729495bfe14707b"></span><span
class="n"><span class="pre">ArrowErrorCode</span></span><span class="w">
</span><span class="sig-name descname"><span class="n"><span class= [...]
-<dd><p>Finalize the most recently encoded message to a buffer. </p>
+<dt class="sig sig-object cpp"
id="_CPPv429ArrowIpcEncoderFinalizeBufferP15ArrowIpcEncodercP11ArrowBuffer">
+<span
id="_CPPv329ArrowIpcEncoderFinalizeBufferP15ArrowIpcEncodercP11ArrowBuffer"></span><span
id="_CPPv229ArrowIpcEncoderFinalizeBufferP15ArrowIpcEncodercP11ArrowBuffer"></span><span
id="ArrowIpcEncoderFinalizeBuffer__ArrowIpcEncoderP.c.ArrowBufferP"></span><span
class="target"
id="group__nanoarrow__ipc_1ga2aef8b5685f922a32bd783dd62706936"></span><span
class="n"><span class="pre">ArrowErrorCode</span></span><span class="w">
</span><span class="sig-name descname"><span class="n"><span cl [...]
+<dd><p>Finalize the most recently encoded message into a buffer. </p>
+<p>If specified, the message will be encapsulated (prefixed with the
continuation marker and the header size and 0-padded to a multiple of 8
bytes).</p>
<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"
id="_CPPv427ArrowIpcEncoderEncodeSchemaP15ArrowIpcEncoderPK11ArrowSchemaP10ArrowError">
+<span
id="_CPPv327ArrowIpcEncoderEncodeSchemaP15ArrowIpcEncoderPK11ArrowSchemaP10ArrowError"></span><span
id="_CPPv227ArrowIpcEncoderEncodeSchemaP15ArrowIpcEncoderPK11ArrowSchemaP10ArrowError"></span><span
id="ArrowIpcEncoderEncodeSchema__ArrowIpcEncoderP.ArrowSchemaCP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow__ipc_1ga00072ca08e05923bb50de6112e722253"></span><span
class="n"><span class="pre">ArrowErrorCode</span></span><span class="w">
</span><span class="sig-name des [...]
+<dd><p>Encode an ArrowSchema. </p>
+<p>Returns ENOMEM if allocation fails, NANOARROW_OK otherwise. </p>
+</dd></dl>
+
</div>
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv420ArrowIpcSharedBuffer">
@@ -1012,7 +1020,8 @@ document.write(`
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv429ArrowIpcArrayStreamReaderInitP16ArrowArrayStreamP19ArrowIpcInputStreamP32ArrowIpcArrayStreamReaderOptions"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcArrayStreamReaderInit()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv419ArrowIpcEncoderInitP15ArrowIpcEncoder"><code class="docutils
literal notranslate"><span
class="pre">ArrowIpcEncoderInit()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv420ArrowIpcEncoderResetP15ArrowIpcEncoder"><code class="docutils
literal notranslate"><span
class="pre">ArrowIpcEncoderReset()</span></code></a></li>
-<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv429ArrowIpcEncoderFinalizeBufferP15ArrowIpcEncoderP11ArrowBuffer"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcEncoderFinalizeBuffer()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv429ArrowIpcEncoderFinalizeBufferP15ArrowIpcEncodercP11ArrowBuffer"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcEncoderFinalizeBuffer()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv427ArrowIpcEncoderEncodeSchemaP15ArrowIpcEncoderPK11ArrowSchemaP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcEncoderEncodeSchema()</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>
diff --git a/main/searchindex.js b/main/searchindex.js
index c1afaac4..3f377f6b 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
