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 0cb3fa96 update documentation for tag main
0cb3fa96 is described below
commit 0cb3fa96dc4b9a96442559b115a82a5b416f4972
Author: GitHub Actions <[email protected]>
AuthorDate: Wed Jul 31 16:22:05 2024 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1097552 -> 1121367 bytes
main/.doctrees/reference/ipc.doctree | Bin 282106 -> 318913 bytes
main/genindex.html | 20 +++++++++--
main/objects.inv | Bin 16727 -> 17046 bytes
main/r/pkgdown.yml | 2 +-
main/reference/ipc.html | 68 +++++++++++++++++++++++++++++++++++
main/searchindex.js | 2 +-
7 files changed, 88 insertions(+), 4 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 694e6f85..54702371 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 c0f78a7b..0c3a43a2 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 0a381196..2246098f 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -669,14 +669,14 @@ document.write(`
</li>
<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>
</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#_CPPv424ArrowDeviceArrayViewInitP20ArrowDeviceArrayView">ArrowDeviceArrayViewInit
(C++ function)</a>
</li>
<li><a
href="reference/device.html#_CPPv425ArrowDeviceArrayViewResetP20ArrowDeviceArrayView">ArrowDeviceArrayViewReset
(C++ function)</a>
@@ -842,6 +842,20 @@ document.write(`
<li><a
href="reference/ipc.html#_CPPv4N23ArrowIpcMetadataVersion33NANOARROW_IPC_METADATA_VERSION_V4E">ArrowIpcMetadataVersion::NANOARROW_IPC_METADATA_VERSION_V4
(C++ enumerator)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv4N23ArrowIpcMetadataVersion33NANOARROW_IPC_METADATA_VERSION_V5E">ArrowIpcMetadataVersion::NANOARROW_IPC_METADATA_VERSION_V5
(C++ enumerator)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv420ArrowIpcOutputStream">ArrowIpcOutputStream
(C++ struct)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv4N20ArrowIpcOutputStream12private_dataE">ArrowIpcOutputStream::private_data
(C++ member)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv4N20ArrowIpcOutputStream7releaseE">ArrowIpcOutputStream::release
(C++ member)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv4N20ArrowIpcOutputStream5writeE">ArrowIpcOutputStream::write
(C++ member)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv430ArrowIpcOutputStreamInitBufferP20ArrowIpcOutputStreamP11ArrowBuffer">ArrowIpcOutputStreamInitBuffer
(C++ function)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv428ArrowIpcOutputStreamInitFileP20ArrowIpcOutputStreamPvi">ArrowIpcOutputStreamInitFile
(C++ function)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv424ArrowIpcOutputStreamMoveP20ArrowIpcOutputStreamP20ArrowIpcOutputStream">ArrowIpcOutputStreamMove
(C++ function)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv420ArrowIpcSharedBuffer">ArrowIpcSharedBuffer
(C++ struct)</a>
</li>
@@ -1460,6 +1474,8 @@ document.write(`
<li><a href="reference/ipc.html#_CPPv413UniqueEncoder">UniqueEncoder
(C++ type)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv417UniqueInputStream">UniqueInputStream (C++
type)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv418UniqueOutputStream">UniqueOutputStream (C++
type)</a>
</li>
<li><a href="reference/cpp.html#_CPPv412UniqueSchema">UniqueSchema (C++
type)</a>
</li>
diff --git a/main/objects.inv b/main/objects.inv
index 626c8ebb..a9af2f26 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 52afdae4..09d28b4e 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-31T01:13Z
+last_built: 2024-07-31T16:21Z
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index 05209927..2407123c 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -673,6 +673,7 @@ document.write(`
<dt class="sig sig-object cpp"
id="_CPPv429ArrowIpcInputStreamInitBufferP19ArrowIpcInputStreamP11ArrowBuffer">
<span
id="_CPPv329ArrowIpcInputStreamInitBufferP19ArrowIpcInputStreamP11ArrowBuffer"></span><span
id="_CPPv229ArrowIpcInputStreamInitBufferP19ArrowIpcInputStreamP11ArrowBuffer"></span><span
id="ArrowIpcInputStreamInitBuffer__ArrowIpcInputStreamP.ArrowBufferP"></span><span
class="target"
id="group__nanoarrow__ipc_1gaaaa9c7ecbbf422341880881287f821ea"></span><span
class="n"><span class="pre">ArrowErrorCode</span></span><span class="w">
</span><span class="sig-name descname"><span class="n"> [...]
<dd><p>Create an input stream from an ArrowBuffer. </p>
+<p>The stream takes ownership of the buffer and reads bytes from it. </p>
</dd></dl>
<dl class="cpp function">
@@ -717,6 +718,26 @@ 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="_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 [...]
+<dd><p>Transfer ownership of an <a class="reference internal"
href="#struct_arrow_ipc_output_stream"><span class="std
std-ref">ArrowIpcOutputStream</span></a>. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv430ArrowIpcOutputStreamInitBufferP20ArrowIpcOutputStreamP11ArrowBuffer">
+<span
id="_CPPv330ArrowIpcOutputStreamInitBufferP20ArrowIpcOutputStreamP11ArrowBuffer"></span><span
id="_CPPv230ArrowIpcOutputStreamInitBufferP20ArrowIpcOutputStreamP11ArrowBuffer"></span><span
id="ArrowIpcOutputStreamInitBuffer__ArrowIpcOutputStreamP.ArrowBufferP"></span><span
class="target"
id="group__nanoarrow__ipc_1ga5fb2c478615771599988ae84504869c7"></span><span
class="n"><span class="pre">ArrowErrorCode</span></span><span class="w">
</span><span class="sig-name descname"><span clas [...]
+<dd><p>Create an output stream from an ArrowBuffer. </p>
+<p>All bytes witten to the stream will be appended to the buffer. The stream
does not take ownership of the buffer. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv428ArrowIpcOutputStreamInitFileP20ArrowIpcOutputStreamPvi">
+<span
id="_CPPv328ArrowIpcOutputStreamInitFileP20ArrowIpcOutputStreamPvi"></span><span
id="_CPPv228ArrowIpcOutputStreamInitFileP20ArrowIpcOutputStreamPvi"></span><span
id="ArrowIpcOutputStreamInitFile__ArrowIpcOutputStreamP.voidP.i"></span><span
class="target"
id="group__nanoarrow__ipc_1ga4db0bd67565d6d57e2b062c6853dcb4d"></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">ArrowIpcO [...]
+<dd><p>Create an output stream from a C FILE* pointer. </p>
+<p>Note that the <a class="reference internal"
href="#struct_arrow_ipc_output_stream"><span class="std
std-ref">ArrowIpcOutputStream</span></a> has no mechanism to communicate an
error if file_ptr fails to close. If this behaviour is needed, pass false to
close_on_release and handle closing the file independently from stream. </p>
+</dd></dl>
+
</div>
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv420ArrowIpcSharedBuffer">
@@ -887,6 +908,37 @@ document.write(`
</div>
</dd></dl>
+<dl class="cpp struct">
+<dt class="sig sig-object cpp" id="_CPPv420ArrowIpcOutputStream">
+<span id="_CPPv320ArrowIpcOutputStream"></span><span
id="_CPPv220ArrowIpcOutputStream"></span><span
id="ArrowIpcOutputStream"></span><span class="target"
id="struct_arrow_ipc_output_stream"></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">ArrowIpcOutputStream</span></span></span><a class="headerlink"
href="#_CPPv420ArrowIpcOutputStream" title="Link to this definition">#</a><br
/></dt>
+<dd><div class="docutils container">
+<em>#include <nanoarrow_ipc.h></em></div>
+<p>An user-extensible output data sink. </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="_CPPv4N20ArrowIpcOutputStream5writeE">
+<span id="_CPPv3N20ArrowIpcOutputStream5writeE"></span><span
id="_CPPv2N20ArrowIpcOutputStream5writeE"></span><span class="target"
id="struct_arrow_ipc_output_stream_1af9e2c1a7153f5d1c2c9330f3639dfec8"></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">write</span></span></span><span c [...]
+<dd><p>Write up to buf_size_bytes from stream into buf. </p>
+<p>The actual number of bytes written is placed in the value pointed to by
size_read_out. Returns NANOARROW_OK on success. </p>
+</dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N20ArrowIpcOutputStream7releaseE">
+<span id="_CPPv3N20ArrowIpcOutputStream7releaseE"></span><span
id="_CPPv2N20ArrowIpcOutputStream7releaseE"></span><span class="target"
id="struct_arrow_ipc_output_stream_1a1d6f799f4ca557a23768550e8c022a13"></span><span
class="kt"><span class="pre">void</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">release</span></span></span><span clas [...]
+<dd><p>Release the stream and any resources it may be holding. </p>
+<p>Release callback implementations must set the release member to NULL.
Callers must check that the release callback is not NULL before calling read()
or <a class="reference internal"
href="#struct_arrow_ipc_output_stream_1a1d6f799f4ca557a23768550e8c022a13"><span
class="std std-ref">release()</span></a>. </p>
+</dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp"
id="_CPPv4N20ArrowIpcOutputStream12private_dataE">
+<span id="_CPPv3N20ArrowIpcOutputStream12private_dataE"></span><span
id="_CPPv2N20ArrowIpcOutputStream12private_dataE"></span><span
id="ArrowIpcOutputStream::private_data__voidP"></span><span class="target"
id="struct_arrow_ipc_output_stream_1a6f4c04f5c2cbbb20ab177eff9f40c75c"></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</s [...]
+<dd><p>Private implementation-defined data. </p>
+</dd></dl>
+
+</div>
+</dd></dl>
+
</dd></dl>
</section>
@@ -916,6 +968,12 @@ document.write(`
<dd><p>Class wrapping a unique struct <a class="reference internal"
href="#struct_arrow_ipc_input_stream"><span class="std
std-ref">ArrowIpcInputStream</span></a>. </p>
</dd></dl>
+<dl class="cpp type">
+<dt class="sig sig-object cpp" id="_CPPv418UniqueOutputStream">
+<span id="_CPPv318UniqueOutputStream"></span><span
id="_CPPv218UniqueOutputStream"></span><span class="target"
id="group__nanoarrow__ipc__hpp-unique_1ga812e2e601c4504e43139d284aca50040"></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">UniqueOutputStream</span></span></span><span class="w">
</span><span class="p"><span class="pre">=</span></span><span class="w">
</span><span class="n"><spa [...]
+<dd><p>Class wrapping a unique struct <a class="reference internal"
href="#struct_arrow_ipc_output_stream"><span class="std
std-ref">ArrowIpcOutputStream</span></a>. </p>
+</dd></dl>
+
</div>
</dd></dl>
@@ -1022,6 +1080,9 @@ 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="#_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>
<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>
@@ -1053,12 +1114,19 @@ document.write(`
<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>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv420ArrowIpcOutputStream"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcOutputStream</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="#_CPPv4N20ArrowIpcOutputStream5writeE"><code class="docutils literal
notranslate"><span
class="pre">ArrowIpcOutputStream::write</span></code></a></li>
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N20ArrowIpcOutputStream7releaseE"><code class="docutils literal
notranslate"><span
class="pre">ArrowIpcOutputStream::release</span></code></a></li>
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N20ArrowIpcOutputStream12private_dataE"><code class="docutils
literal notranslate"><span
class="pre">ArrowIpcOutputStream::private_data</span></code></a></li>
+</ul>
+</li>
</ul>
</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="#_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>
</ul>
</li>
</ul>
diff --git a/main/searchindex.js b/main/searchindex.js
index 3f377f6b..85bc3c4a 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
