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 d0c6a4af update documentation for tag main
d0c6a4af is described below
commit d0c6a4af93940d3d415d3f67462b2c061153192f
Author: GitHub Actions <[email protected]>
AuthorDate: Wed Aug 7 00:59:33 2024 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1121203 -> 1116618 bytes
main/.doctrees/reference/ipc.doctree | Bin 318913 -> 309954 bytes
main/genindex.html | 14 ++++--------
main/objects.inv | Bin 17046 -> 16981 bytes
main/r/pkgdown.yml | 2 +-
main/reference/ipc.html | 41 +++++++++--------------------------
main/searchindex.js | 2 +-
7 files changed, 16 insertions(+), 43 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 7d293041..8d500acb 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 0c3a43a2..a47f0214 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 2246098f..7e4f2d0c 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -672,11 +672,11 @@ document.write(`
<li><a
href="reference/device.html#_CPPv420ArrowDeviceArrayView">ArrowDeviceArrayView
(C++ struct)</a>
</li>
<li><a
href="reference/device.html#_CPPv424ArrowDeviceArrayViewCopyP20ArrowDeviceArrayViewP11ArrowDeviceP16ArrowDeviceArray">ArrowDeviceArrayViewCopy
(C++ function)</a>
-</li>
- <li><a
href="reference/device.html#_CPPv429ArrowDeviceArrayViewCopyAsyncP20ArrowDeviceArrayViewP11ArrowDeviceP16ArrowDeviceArrayPv">ArrowDeviceArrayViewCopyAsync
(C++ function)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
+ <li><a
href="reference/device.html#_CPPv429ArrowDeviceArrayViewCopyAsyncP20ArrowDeviceArrayViewP11ArrowDeviceP16ArrowDeviceArrayPv">ArrowDeviceArrayViewCopyAsync
(C++ function)</a>
+</li>
<li><a
href="reference/device.html#_CPPv424ArrowDeviceArrayViewInitP20ArrowDeviceArrayView">ArrowDeviceArrayViewInit
(C++ function)</a>
</li>
<li><a
href="reference/device.html#_CPPv425ArrowDeviceArrayViewResetP20ArrowDeviceArrayView">ArrowDeviceArrayViewReset
(C++ function)</a>
@@ -776,18 +776,12 @@ document.write(`
<li><a
href="reference/ipc.html#_CPPv427ArrowIpcDecoderVerifyHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError">ArrowIpcDecoderVerifyHeader
(C++ function)</a>
</li>
<li><a href="reference/ipc.html#_CPPv415ArrowIpcEncoder">ArrowIpcEncoder
(C++ struct)</a>
-</li>
- <li><a
href="reference/ipc.html#_CPPv4N15ArrowIpcEncoder11body_lengthE">ArrowIpcEncoder::body_length
(C++ member)</a>
-</li>
- <li><a
href="reference/ipc.html#_CPPv4N15ArrowIpcEncoder5codecE">ArrowIpcEncoder::codec
(C++ member)</a>
-</li>
- <li><a
href="reference/ipc.html#_CPPv4N15ArrowIpcEncoder13encode_bufferE">ArrowIpcEncoder::encode_buffer
(C++ member)</a>
-</li>
- <li><a
href="reference/ipc.html#_CPPv4N15ArrowIpcEncoder19encode_buffer_stateE">ArrowIpcEncoder::encode_buffer_state
(C++ member)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv4N15ArrowIpcEncoder12private_dataE">ArrowIpcEncoder::private_data
(C++ member)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv427ArrowIpcEncoderEncodeSchemaP15ArrowIpcEncoderPK11ArrowSchemaP10ArrowError">ArrowIpcEncoderEncodeSchema
(C++ function)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv438ArrowIpcEncoderEncodeSimpleRecordBatchP15ArrowIpcEncoderPK14ArrowArrayViewP11ArrowBufferP10ArrowError">ArrowIpcEncoderEncodeSimpleRecordBatch
(C++ function)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv429ArrowIpcEncoderFinalizeBufferP15ArrowIpcEncodercP11ArrowBuffer">ArrowIpcEncoderFinalizeBuffer
(C++ function)</a>
</li>
diff --git a/main/objects.inv b/main/objects.inv
index a9af2f26..5cc8a5b3 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 3e54c57c..6776d26d 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-06T19:30Z
+last_built: 2024-08-07T00:59Z
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index 2407123c..185af2c1 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -596,7 +596,7 @@ document.write(`
<dt class="sig sig-object cpp"
id="_CPPv425ArrowIpcDecoderPeekHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError">
<span
id="_CPPv325ArrowIpcDecoderPeekHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError"></span><span
id="_CPPv225ArrowIpcDecoderPeekHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError"></span><span
id="ArrowIpcDecoderPeekHeader__ArrowIpcDecoderP.ArrowBufferView.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow__ipc_1ga02b0a558c785e952737182e04eba936d"></span><span
class="n"><span class="pre">ArrowErrorCode</span></span><span class="w">
</span><span class="sig-name des [...]
<dd><p>Peek at a message header. </p>
-<p>The first 8 bytes of an Arrow IPC message are 0xFFFFFF followed by the size
of the header as a little-endian 32-bit integer. <a class="reference internal"
href="#group__nanoarrow__ipc_1ga02b0a558c785e952737182e04eba936d"><span
class="std std-ref">ArrowIpcDecoderPeekHeader()</span></a> reads these bytes
and returns ESPIPE if there are not enough remaining bytes in data to read the
entire header message, EINVAL if the first 8 bytes are not valid, ENODATA if
the Arrow end-of-stream indic [...]
+<p>The first 8 bytes of an Arrow IPC message are 0xFFFFFFFF followed by the
size of the header as a little-endian 32-bit integer. <a class="reference
internal"
href="#group__nanoarrow__ipc_1ga02b0a558c785e952737182e04eba936d"><span
class="std std-ref">ArrowIpcDecoderPeekHeader()</span></a> reads these bytes
and returns ESPIPE if there are not enough remaining bytes in data to read the
entire header message, EINVAL if the first 8 bytes are not valid, ENODATA if
the Arrow end-of-stream ind [...]
</dd></dl>
<dl class="cpp function">
@@ -718,6 +718,14 @@ document.write(`
<p>Returns ENOMEM if allocation fails, NANOARROW_OK otherwise. </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv438ArrowIpcEncoderEncodeSimpleRecordBatchP15ArrowIpcEncoderPK14ArrowArrayViewP11ArrowBufferP10ArrowError">
+<span
id="_CPPv338ArrowIpcEncoderEncodeSimpleRecordBatchP15ArrowIpcEncoderPK14ArrowArrayViewP11ArrowBufferP10ArrowError"></span><span
id="_CPPv238ArrowIpcEncoderEncodeSimpleRecordBatchP15ArrowIpcEncoderPK14ArrowArrayViewP11ArrowBufferP10ArrowError"></span><span
id="ArrowIpcEncoderEncodeSimpleRecordBatch__ArrowIpcEncoderP.ArrowArrayViewCP.ArrowBufferP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow__ipc_1gae8f7353ed72a61444f74e3ef04af0dba"></span><span
class="n"><span class= [...]
+<dd><p>Encode a struct typed ArrayView to a flatbuffer RecordBatch, embedded
in a Message. </p>
+<p>Body buffers are concatenated into a contiguous, padded body_buffer.</p>
+<p>Returns ENOMEM if allocation fails, NANOARROW_OK otherwise. </p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv424ArrowIpcOutputStreamMoveP20ArrowIpcOutputStreamP20ArrowIpcOutputStream">
<span
id="_CPPv324ArrowIpcOutputStreamMoveP20ArrowIpcOutputStreamP20ArrowIpcOutputStream"></span><span
id="_CPPv224ArrowIpcOutputStreamMoveP20ArrowIpcOutputStreamP20ArrowIpcOutputStream"></span><span
id="ArrowIpcOutputStreamMove__ArrowIpcOutputStreamP.ArrowIpcOutputStreamP"></span><span
class="target"
id="group__nanoarrow__ipc_1gad51a76f80c57e44264c945392bb189dd"></span><span
class="kt"><span class="pre">void</span></span><span class="w"> </span><span
class="sig-name descname"><span clas [...]
@@ -873,32 +881,6 @@ document.write(`
<p>This structure is intended to be allocated by the caller, initialized using
<a class="reference internal"
href="#group__nanoarrow__ipc_1gaadfe882155e9215178c3e21e4f212ed7"><span
class="std std-ref">ArrowIpcEncoderInit()</span></a>, and released with <a
class="reference internal"
href="#group__nanoarrow__ipc_1gac28252286237ba1b3a235a0345bbe3d1"><span
class="std std-ref">ArrowIpcEncoderReset()</span></a>. </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="_CPPv4N15ArrowIpcEncoder5codecE">
-<span id="_CPPv3N15ArrowIpcEncoder5codecE"></span><span
id="_CPPv2N15ArrowIpcEncoder5codecE"></span><span
id="ArrowIpcEncoder::codec__ArrowIpcCompressionType"></span><span
class="target"
id="struct_arrow_ipc_encoder_1a982847c09e5c50b25c2cc6899754b19f"></span><span
class="k"><span class="pre">enum</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv423ArrowIpcCompressionType"
title="ArrowIpcCompressionType"><span class="n"><span
class="pre">ArrowIpcCompressionTy [...]
-<dd><p>Compression to encode in the next RecordBatch message. </p>
-</dd></dl>
-
-<dl class="cpp var">
-<dt class="sig sig-object cpp" id="_CPPv4N15ArrowIpcEncoder13encode_bufferE">
-<span id="_CPPv3N15ArrowIpcEncoder13encode_bufferE"></span><span
id="_CPPv2N15ArrowIpcEncoder13encode_bufferE"></span><span class="target"
id="struct_arrow_ipc_encoder_1af6aa42efbbdbd4e5acc060074ce64119"></span><span
class="n"><span class="pre">ArrowErrorCode</span></span><span class="w">
</span><span class="p"><span class="pre">(</span></span><span class="p"><span
class="pre">*</span></span><span class="sig-name descname"><span
class="n"><span class="pre">encode_buffer</span></span></sp [...]
-<dd><p>Callback invoked against each buffer to be encoded. </p>
-<p>Encoding of buffers is left as a callback to accommodate dissociated data
storage. One implementation of this callback might copy all buffers into a
contiguous body for use in an arrow IPC stream, another implementation might
store offsets and lengths relative to a known arena. </p>
-</dd></dl>
-
-<dl class="cpp var">
-<dt class="sig sig-object cpp"
id="_CPPv4N15ArrowIpcEncoder19encode_buffer_stateE">
-<span id="_CPPv3N15ArrowIpcEncoder19encode_buffer_stateE"></span><span
id="_CPPv2N15ArrowIpcEncoder19encode_buffer_stateE"></span><span
id="ArrowIpcEncoder::encode_buffer_state__voidP"></span><span class="target"
id="struct_arrow_ipc_encoder_1a996fe0ce8cdfdec38ef3a1924a81c069"></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">encode_buffer_s [...]
-<dd><p>Pointer to arbitrary data used by <a class="reference internal"
href="#struct_arrow_ipc_encoder_1af6aa42efbbdbd4e5acc060074ce64119"><span
class="std std-ref">encode_buffer()</span></a></p>
-</dd></dl>
-
-<dl class="cpp var">
-<dt class="sig sig-object cpp" id="_CPPv4N15ArrowIpcEncoder11body_lengthE">
-<span id="_CPPv3N15ArrowIpcEncoder11body_lengthE"></span><span
id="_CPPv2N15ArrowIpcEncoder11body_lengthE"></span><span
id="ArrowIpcEncoder::body_length__int64_t"></span><span class="target"
id="struct_arrow_ipc_encoder_1afcba218a6128adc3f7d94b73432c50e5"></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">body_length</span></span></span><a class="headerlink"
href="#_CPPv4N15ArrowIpcEncode [...]
-<dd><p>Finalized body length of the most recently encoded RecordBatch message.
</p>
-<p>(This is initially 0 and <a class="reference internal"
href="#struct_arrow_ipc_encoder_1af6aa42efbbdbd4e5acc060074ce64119"><span
class="std std-ref">encode_buffer()</span></a> is expected to update it. After
all buffers are encoded, this will be written to the RecordBatch’s .bodyLength)
</p>
-</dd></dl>
-
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N15ArrowIpcEncoder12private_dataE">
<span id="_CPPv3N15ArrowIpcEncoder12private_dataE"></span><span
id="_CPPv2N15ArrowIpcEncoder12private_dataE"></span><span
id="ArrowIpcEncoder::private_data__voidP"></span><span class="target"
id="struct_arrow_ipc_encoder_1a84655c3db1b57bebc3c5ddee67cf0d67"></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
[...]
@@ -1080,6 +1062,7 @@ document.write(`
<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="#_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="#_CPPv438ArrowIpcEncoderEncodeSimpleRecordBatchP15ArrowIpcEncoderPK14ArrowArrayViewP11ArrowBufferP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcEncoderEncodeSimpleRecordBatch()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv424ArrowIpcOutputStreamMoveP20ArrowIpcOutputStreamP20ArrowIpcOutputStream"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcOutputStreamMove()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv430ArrowIpcOutputStreamInitBufferP20ArrowIpcOutputStreamP11ArrowBuffer"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcOutputStreamInitBuffer()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv428ArrowIpcOutputStreamInitFileP20ArrowIpcOutputStreamPvi"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcOutputStreamInitFile()</span></code></a></li>
@@ -1107,10 +1090,6 @@ document.write(`
</ul>
</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv415ArrowIpcEncoder"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcEncoder</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="#_CPPv4N15ArrowIpcEncoder5codecE"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcEncoder::codec</span></code></a></li>
-<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N15ArrowIpcEncoder13encode_bufferE"><code class="docutils literal
notranslate"><span
class="pre">ArrowIpcEncoder::encode_buffer</span></code></a></li>
-<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N15ArrowIpcEncoder19encode_buffer_stateE"><code class="docutils
literal notranslate"><span
class="pre">ArrowIpcEncoder::encode_buffer_state</span></code></a></li>
-<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N15ArrowIpcEncoder11body_lengthE"><code class="docutils literal
notranslate"><span
class="pre">ArrowIpcEncoder::body_length</span></code></a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N15ArrowIpcEncoder12private_dataE"><code class="docutils literal
notranslate"><span
class="pre">ArrowIpcEncoder::private_data</span></code></a></li>
</ul>
</li>
diff --git a/main/searchindex.js b/main/searchindex.js
index 85bc3c4a..a035c303 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
