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 3aa17790 update documentation for tag main
3aa17790 is described below
commit 3aa17790f4854a5049c4cdd3e220bcfb0dcb1d91
Author: GitHub Actions <[email protected]>
AuthorDate: Fri Mar 21 04:01:29 2025 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1168194 -> 1159841 bytes
main/.doctrees/reference/c.doctree | Bin 1027684 -> 1024262 bytes
main/.doctrees/reference/ipc.doctree | Bin 299512 -> 295612 bytes
main/genindex.html | 6 ------
main/objects.inv | Bin 22163 -> 22065 bytes
main/r/pkgdown.yml | 2 +-
main/reference/c.html | 5 ++---
main/reference/ipc.html | 14 ++++++--------
main/searchindex.js | 2 +-
9 files changed, 10 insertions(+), 19 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 6fa11eb4..04c6f87b 100644
Binary files a/main/.doctrees/environment.pickle and
b/main/.doctrees/environment.pickle differ
diff --git a/main/.doctrees/reference/c.doctree
b/main/.doctrees/reference/c.doctree
index 4f2379b1..69f43fd8 100644
Binary files a/main/.doctrees/reference/c.doctree and
b/main/.doctrees/reference/c.doctree differ
diff --git a/main/.doctrees/reference/ipc.doctree
b/main/.doctrees/reference/ipc.doctree
index ae783b39..fc1f0e46 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 2f80ce66..8bdf8216 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -713,8 +713,6 @@
<li><a
href="reference/c.html#_CPPv4N12ArrowDecimal5scaleE">ArrowDecimal::scale (C++
member)</a>
</li>
<li><a
href="reference/c.html#_CPPv4N12ArrowDecimal5wordsE">ArrowDecimal::words (C++
member)</a>
-</li>
- <li><a
href="reference/c.html#_CPPv432ArrowDecimalAppendStringToBufferPK12ArrowDecimalP11ArrowBuffer">ArrowDecimalAppendStringToBuffer
(C++ function)</a>
</li>
<li><a
href="reference/c.html#_CPPv420ArrowDecimalGetBytesPK12ArrowDecimalP7uint8_t">ArrowDecimalGetBytes
(C++ function)</a>
</li>
@@ -829,8 +827,6 @@
<li><a
href="reference/ipc.html#_CPPv4N32ArrowIpcArrayStreamReaderOptions11field_indexE">ArrowIpcArrayStreamReaderOptions::field_index
(C++ member)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv4N32ArrowIpcArrayStreamReaderOptions18use_shared_buffersE">ArrowIpcArrayStreamReaderOptions::use_shared_buffers
(C++ member)</a>
-</li>
- <li><a
href="reference/ipc.html#_CPPv420ArrowIpcCheckRuntimeP10ArrowError">ArrowIpcCheckRuntime
(C++ function)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv423ArrowIpcCompressionType">ArrowIpcCompressionType
(C++ enum)</a>
</li>
@@ -875,8 +871,6 @@
<li><a href="reference/ipc.html#_CPPv415ArrowIpcEncoder">ArrowIpcEncoder
(C++ struct)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv4N15ArrowIpcEncoder12private_dataE">ArrowIpcEncoder::private_data
(C++ member)</a>
-</li>
- <li><a
href="reference/ipc.html#_CPPv420ArrowIpcEncoderResetP15ArrowIpcEncoder">ArrowIpcEncoderReset
(C++ function)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv418ArrowIpcEndianness">ArrowIpcEndianness (C++
enum)</a>
</li>
diff --git a/main/objects.inv b/main/objects.inv
index 789bc82b..3c434983 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 df1bad3c..a5dbb8ad 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,4 +2,4 @@ pandoc: 3.1.3
pkgdown: 2.1.1
pkgdown_sha: ~
articles: {}
-last_built: 2025-03-20T16:06Z
+last_built: 2025-03-21T04:01Z
diff --git a/main/reference/c.html b/main/reference/c.html
index 2ef9f643..86961e6a 100644
--- a/main/reference/c.html
+++ b/main/reference/c.html
@@ -2185,8 +2185,8 @@
</dd></dl>
<dl class="cpp function">
-<dt class="sig sig-object cpp"
id="_CPPv432ArrowDecimalAppendStringToBufferPK12ArrowDecimalP11ArrowBuffer">
-<span
id="_CPPv332ArrowDecimalAppendStringToBufferPK12ArrowDecimalP11ArrowBuffer"></span><span
id="_CPPv232ArrowDecimalAppendStringToBufferPK12ArrowDecimalP11ArrowBuffer"></span><span
id="ArrowDecimalAppendStringToBuffer__ArrowDecimalCP.ArrowBufferP"></span><span
class="target"
id="group__nanoarrow-utils_1gae9d02af6b295befe2791704d68e484ff"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></s [...]
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow-utils_1ga9d25e8aa84fec657ea9eb8636e4f5bd0"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowDecimalAppendStringToBuffer</span> <span
class="pre">(const</span> <span class="pre">struct</span> <span
class="pre">ArrowDecimal</span> <span class="pre">*decimal,</span> <span
class="pre">struct</span> <span class="pre">ArrowBuffer</span> <span
class="pre">*buffer [...]
<dd><p>Get the decimal value of an <a class="reference internal"
href="#struct_arrow_decimal"><span class="std std-ref">ArrowDecimal</span></a>
as a string. </p>
</dd></dl>
@@ -2919,7 +2919,6 @@
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv418ArrowDecimalSetIntP12ArrowDecimal7int64_t"><code class="docutils
literal notranslate"><span
class="pre">ArrowDecimalSetInt()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv418ArrowDecimalNegateP12ArrowDecimal"><code class="docutils literal
notranslate"><span class="pre">ArrowDecimalNegate()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv420ArrowDecimalSetBytesP12ArrowDecimalPK7uint8_t"><code
class="docutils literal notranslate"><span
class="pre">ArrowDecimalSetBytes()</span></code></a></li>
-<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv432ArrowDecimalAppendStringToBufferPK12ArrowDecimalP11ArrowBuffer"><code
class="docutils literal notranslate"><span
class="pre">ArrowDecimalAppendStringToBuffer()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv421ArrowFloatToHalfFloatf"><code class="docutils literal
notranslate"><span class="pre">ArrowFloatToHalfFloat()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv421ArrowHalfFloatToFloat8uint16_t"><code class="docutils literal
notranslate"><span class="pre">ArrowHalfFloatToFloat()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv419ArrowResolveChunk647int64_tPK7int64_t7int64_t7int64_t"><code
class="docutils literal notranslate"><span
class="pre">ArrowResolveChunk64()</span></code></a></li>
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index 41cf1841..194ee9d0 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -534,8 +534,8 @@
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-functions">Functions</p>
<dl class="cpp function">
-<dt class="sig sig-object cpp" id="_CPPv420ArrowIpcCheckRuntimeP10ArrowError">
-<span id="_CPPv320ArrowIpcCheckRuntimeP10ArrowError"></span><span
id="_CPPv220ArrowIpcCheckRuntimeP10ArrowError"></span><span
id="ArrowIpcCheckRuntime__ArrowErrorP"></span><span class="target"
id="group__nanoarrow__ipc_1ga15c2f5e02a100fdc951083a47c70f2be"></span><a
class="reference internal" href="c.html#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span class="w"> </span><span
class="sig-name descname"><span class="n">< [...]
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow__ipc_1ga7228d11cc56a1e2f16d286ede17431e8"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span class="pre">ArrowIpcCheckRuntime</span>
<span class="pre">(struct</span> <span class="pre">ArrowError</span> <span
class="pre">*error)</span></span></dt>
<dd><p>Checks the nanoarrow runtime to make sure the run/build versions match.
</p>
</dd></dl>
@@ -707,12 +707,12 @@
<dt class="sig sig-object cpp">
<span class="target"
id="group__nanoarrow__ipc_1gac9e2be50456703e6b849ee8b0f572ccb"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span class="pre">ArrowIpcEncoderInit</span>
<span class="pre">(struct</span> <span class="pre">ArrowIpcEncoder</span> <span
class="pre">*encoder)</span></span></dt>
<dd><p>Initialize an encoder. </p>
-<p>If NANOARROW_OK is returned, the caller must call <a class="reference
internal"
href="#group__nanoarrow__ipc_1gac28252286237ba1b3a235a0345bbe3d1"><span
class="std std-ref">ArrowIpcEncoderReset()</span></a> to release resources
allocated by this function. </p>
+<p>If NANOARROW_OK is returned, the caller must call <a class="reference
internal"
href="#group__nanoarrow__ipc_1ga6d21b710edc00bae3e6fbf9319bd6b19"><span
class="std std-ref">ArrowIpcEncoderReset()</span></a> to release resources
allocated by this function. </p>
</dd></dl>
<dl class="cpp function">
-<dt class="sig sig-object cpp"
id="_CPPv420ArrowIpcEncoderResetP15ArrowIpcEncoder">
-<span id="_CPPv320ArrowIpcEncoderResetP15ArrowIpcEncoder"></span><span
id="_CPPv220ArrowIpcEncoderResetP15ArrowIpcEncoder"></span><span
id="ArrowIpcEncoderReset__ArrowIpcEncoderP"></span><span class="target"
id="group__nanoarrow__ipc_1gac28252286237ba1b3a235a0345bbe3d1"></span><span
class="kt"><span class="pre">void</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">ArrowIpcEncoderReset</span></span></span><span
class="sig-paren">(</spa [...]
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow__ipc_1ga6d21b710edc00bae3e6fbf9319bd6b19"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">void</span> <span class="pre">ArrowIpcEncoderReset</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcEncoder</span> <span
class="pre">*encoder)</span></span></dt>
<dd><p>Release all resources attached to an encoder. </p>
</dd></dl>
@@ -995,7 +995,7 @@
<dd><div class="docutils container">
<em>#include <nanoarrow_ipc.h></em></div>
<p>Encoder for Arrow IPC messages. </p>
-<p>This structure is intended to be allocated by the caller, initialized using
<a class="reference internal"
href="#group__nanoarrow__ipc_1gac9e2be50456703e6b849ee8b0f572ccb"><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>
+<p>This structure is intended to be allocated by the caller, initialized using
<a class="reference internal"
href="#group__nanoarrow__ipc_1gac9e2be50456703e6b849ee8b0f572ccb"><span
class="std std-ref">ArrowIpcEncoderInit()</span></a>, and released with <a
class="reference internal"
href="#group__nanoarrow__ipc_1ga6d21b710edc00bae3e6fbf9319bd6b19"><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">
@@ -1195,9 +1195,7 @@
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N23ArrowIpcCompressionType35NANOARROW_IPC_COMPRESSION_TYPE_ZSTDE"><code
class="docutils literal notranslate"><span
class="pre">NANOARROW_IPC_COMPRESSION_TYPE_ZSTD</span></code></a></li>
</ul>
</li>
-<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv420ArrowIpcCheckRuntimeP10ArrowError"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcCheckRuntime()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv424ArrowIpcSystemEndiannessv"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcSystemEndianness()</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="#_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="#_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="#_CPPv420ArrowIpcDecompressor"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcDecompressor</span></code></a><ul
class="nav section-nav flex-column">
diff --git a/main/searchindex.js b/main/searchindex.js
index 5571d320..96a80095 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-utilities"]],"Buffer utilitie [...]
\ 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-utilities"]],"Buffer utilitie [...]
\ No newline at end of file
