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 23e104b2 update documentation for tag main
23e104b2 is described below
commit 23e104b28ac83ad38d6a38563c2214a11533b57d
Author: GitHub Actions <[email protected]>
AuthorDate: Mon Oct 7 16:05:38 2024 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1180895 -> 1181824 bytes
main/.doctrees/reference/ipc.doctree | Bin 369204 -> 370562 bytes
main/genindex.html | 2 +-
main/objects.inv | Bin 17870 -> 17874 bytes
main/r/pkgdown.yml | 2 +-
main/reference/ipc.html | 17 +++++++++--------
main/searchindex.js | 2 +-
7 files changed, 12 insertions(+), 11 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 4913d571..62bcf79d 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 24fb3f25..e0132ca5 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 d5612e1d..2fb3d7e4 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -779,7 +779,7 @@ document.write(`
</li>
<li><a
href="reference/ipc.html#_CPPv419ArrowIpcDecoderInitP15ArrowIpcDecoder">ArrowIpcDecoderInit
(C++ function)</a>
</li>
- <li><a
href="reference/ipc.html#_CPPv425ArrowIpcDecoderPeekHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError">ArrowIpcDecoderPeekHeader
(C++ function)</a>
+ <li><a
href="reference/ipc.html#_CPPv425ArrowIpcDecoderPeekHeaderP15ArrowIpcDecoder15ArrowBufferViewP7int32_tP10ArrowError">ArrowIpcDecoderPeekHeader
(C++ function)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv420ArrowIpcDecoderResetP15ArrowIpcDecoder">ArrowIpcDecoderReset
(C++ function)</a>
</li>
diff --git a/main/objects.inv b/main/objects.inv
index 4a398278..b0d3aa6a 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 0ffc88c6..ad8ac3c1 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: 2024-10-04T20:29Z
+last_built: 2024-10-07T16:05Z
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index 251f3f5e..bc1b4650 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -593,25 +593,26 @@ document.write(`
</dd></dl>
<dl class="cpp function">
-<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 [...]
+<dt class="sig sig-object cpp"
id="_CPPv425ArrowIpcDecoderPeekHeaderP15ArrowIpcDecoder15ArrowBufferViewP7int32_tP10ArrowError">
+<span
id="_CPPv325ArrowIpcDecoderPeekHeaderP15ArrowIpcDecoder15ArrowBufferViewP7int32_tP10ArrowError"></span><span
id="_CPPv225ArrowIpcDecoderPeekHeaderP15ArrowIpcDecoder15ArrowBufferViewP7int32_tP10ArrowError"></span><span
id="ArrowIpcDecoderPeekHeader__ArrowIpcDecoderP.ArrowBufferView.int32_tP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow__ipc_1ga83e3c2c6e3da406bc1f45b5b81eee5f5"></span><span
class="n"><span class="pre">ArrowErrorCode</span></span><span class="w"> </spa
[...]
<dd><p>Peek at a message header. </p>
-<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 [...]
+<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_1ga83e3c2c6e3da406bc1f45b5b81eee5f5"><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 [...]
+<p>Pre-1.0 messages were not prefixed with 0xFFFFFFFF. For these messages, a
value of 4 will be placed into prefix_size_bytes; otherwise a value of 8 will
be placed into prefix_size_bytes. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv427ArrowIpcDecoderVerifyHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError">
<span
id="_CPPv327ArrowIpcDecoderVerifyHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError"></span><span
id="_CPPv227ArrowIpcDecoderVerifyHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError"></span><span
id="ArrowIpcDecoderVerifyHeader__ArrowIpcDecoderP.ArrowBufferView.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow__ipc_1ga5d19acbf708ca5b4b7cbe32fa81378a6"></span><span
class="n"><span class="pre">ArrowErrorCode</span></span><span class="w">
</span><span class="sig-na [...]
<dd><p>Verify a message header. </p>
-<p>Runs <a class="reference internal"
href="#group__nanoarrow__ipc_1ga02b0a558c785e952737182e04eba936d"><span
class="std std-ref">ArrowIpcDecoderPeekHeader()</span></a> to ensure data is
sufficiently large but additionally runs flatbuffer verification to ensure that
decoding the data will not access memory outside of the buffer specified by
data. <a class="reference internal"
href="#group__nanoarrow__ipc_1ga5d19acbf708ca5b4b7cbe32fa81378a6"><span
class="std std-ref">ArrowIpcDecoderVerify [...]
-<p>Returns as <a class="reference internal"
href="#group__nanoarrow__ipc_1ga02b0a558c785e952737182e04eba936d"><span
class="std std-ref">ArrowIpcDecoderPeekHeader()</span></a> and additionally
will return EINVAL if flatbuffer verification fails. </p>
+<p>Runs <a class="reference internal"
href="#group__nanoarrow__ipc_1ga83e3c2c6e3da406bc1f45b5b81eee5f5"><span
class="std std-ref">ArrowIpcDecoderPeekHeader()</span></a> to ensure data is
sufficiently large but additionally runs flatbuffer verification to ensure that
decoding the data will not access memory outside of the buffer specified by
data. <a class="reference internal"
href="#group__nanoarrow__ipc_1ga5d19acbf708ca5b4b7cbe32fa81378a6"><span
class="std std-ref">ArrowIpcDecoderVerify [...]
+<p>Returns as <a class="reference internal"
href="#group__nanoarrow__ipc_1ga83e3c2c6e3da406bc1f45b5b81eee5f5"><span
class="std std-ref">ArrowIpcDecoderPeekHeader()</span></a> and additionally
will return EINVAL if flatbuffer verification fails. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv427ArrowIpcDecoderDecodeHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError">
<span
id="_CPPv327ArrowIpcDecoderDecodeHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError"></span><span
id="_CPPv227ArrowIpcDecoderDecodeHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError"></span><span
id="ArrowIpcDecoderDecodeHeader__ArrowIpcDecoderP.ArrowBufferView.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow__ipc_1gaa4ea4cae2cca86081b9279e481e4dab0"></span><span
class="n"><span class="pre">ArrowErrorCode</span></span><span class="w">
</span><span class="sig-na [...]
<dd><p>Decode a message header. </p>
-<p>Runs <a class="reference internal"
href="#group__nanoarrow__ipc_1ga02b0a558c785e952737182e04eba936d"><span
class="std std-ref">ArrowIpcDecoderPeekHeader()</span></a> to ensure data is
sufficiently large and decodes the content of the message header. If data
contains a schema message, decoder.endianness and decoder.feature_flags is set
and <a class="reference internal"
href="#group__nanoarrow__ipc_1gab56730acfeaad71f0b31e0616c3cac02"><span
class="std std-ref">ArrowIpcDecoderDecodeSchem [...]
+<p>Runs <a class="reference internal"
href="#group__nanoarrow__ipc_1ga83e3c2c6e3da406bc1f45b5b81eee5f5"><span
class="std std-ref">ArrowIpcDecoderPeekHeader()</span></a> to ensure data is
sufficiently large and decodes the content of the message header. If data
contains a schema message, decoder.endianness and decoder.feature_flags is set
and <a class="reference internal"
href="#group__nanoarrow__ipc_1gab56730acfeaad71f0b31e0616c3cac02"><span
class="std std-ref">ArrowIpcDecoderDecodeSchem [...]
<p>In almost all cases this should be preceded by a call to <a
class="reference internal"
href="#group__nanoarrow__ipc_1ga5d19acbf708ca5b4b7cbe32fa81378a6"><span
class="std std-ref">ArrowIpcDecoderVerifyHeader()</span></a> to ensure decoding
does not access data outside of the specified buffer.</p>
<p>Returns EINVAL if the content of the message cannot be decoded or ENOTSUP
if the content of the message uses features not supported by this library. </p>
</dd></dl>
@@ -816,7 +817,7 @@ document.write(`
<dd><div class="docutils container">
<em>#include <nanoarrow_ipc.h></em></div>
<p>Decoder 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_1ga0a0b859bb7e01fc0a0828233f959492e"><span
class="std std-ref">ArrowIpcDecoderInit()</span></a>, and released with <a
class="reference internal"
href="#group__nanoarrow__ipc_1gad74005e3b4915f5354874d8d84b4303f"><span
class="std std-ref">ArrowIpcDecoderReset()</span></a>. These fields should not
be modified by the caller but can be read following a call [...]
+<p>This structure is intended to be allocated by the caller, initialized using
<a class="reference internal"
href="#group__nanoarrow__ipc_1ga0a0b859bb7e01fc0a0828233f959492e"><span
class="std std-ref">ArrowIpcDecoderInit()</span></a>, and released with <a
class="reference internal"
href="#group__nanoarrow__ipc_1gad74005e3b4915f5354874d8d84b4303f"><span
class="std std-ref">ArrowIpcDecoderReset()</span></a>. These fields should not
be modified by the caller but can be read following a call [...]
<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">
@@ -1140,7 +1141,7 @@ document.write(`
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv432ArrowIpcSharedBufferIsThreadSafev"><code class="docutils literal
notranslate"><span
class="pre">ArrowIpcSharedBufferIsThreadSafe()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv419ArrowIpcDecoderInitP15ArrowIpcDecoder"><code class="docutils
literal notranslate"><span
class="pre">ArrowIpcDecoderInit()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv420ArrowIpcDecoderResetP15ArrowIpcDecoder"><code class="docutils
literal notranslate"><span
class="pre">ArrowIpcDecoderReset()</span></code></a></li>
-<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv425ArrowIpcDecoderPeekHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcDecoderPeekHeader()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv425ArrowIpcDecoderPeekHeaderP15ArrowIpcDecoder15ArrowBufferViewP7int32_tP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcDecoderPeekHeader()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv427ArrowIpcDecoderVerifyHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcDecoderVerifyHeader()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv427ArrowIpcDecoderDecodeHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcDecoderDecodeHeader()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv427ArrowIpcDecoderDecodeSchemaP15ArrowIpcDecoderP11ArrowSchemaP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcDecoderDecodeSchema()</span></code></a></li>
diff --git a/main/searchindex.js b/main/searchindex.js
index 171e3017..bf2a0414 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
