This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/arrow-nanoarrow.git
The following commit(s) were added to refs/heads/gh-pages by this push:
new 27e8404 update documentation for tag dev
27e8404 is described below
commit 27e840445082b349539961b2fb4f9990d91de352
Author: GitHub Actions <[email protected]>
AuthorDate: Tue Jun 6 15:22:10 2023 +0000
update documentation for tag dev
---
dev/c.html | 7 +++++++
dev/genindex.html | 14 ++++++++------
dev/ipc.html | 29 +++++++++++++++--------------
dev/objects.inv | Bin 16418 -> 16513 bytes
dev/r/pkgdown.yml | 2 +-
dev/searchindex.js | 2 +-
6 files changed, 32 insertions(+), 22 deletions(-)
diff --git a/dev/c.html b/dev/c.html
index 58c0a97..239eb4a 100644
--- a/dev/c.html
+++ b/dev/c.html
@@ -661,6 +661,13 @@ document.write(`
<p>Caller is responsible for calling the array->release callback if
NANOARROW_OK is returned. </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv427ArrowArrayInitFromArrayViewP10ArrowArrayP14ArrowArrayViewP10ArrowError">
+<span
id="_CPPv327ArrowArrayInitFromArrayViewP10ArrowArrayP14ArrowArrayViewP10ArrowError"></span><span
id="_CPPv227ArrowArrayInitFromArrayViewP10ArrowArrayP14ArrowArrayViewP10ArrowError"></span><span
id="ArrowArrayInitFromArrayView__ArrowArrayP.ArrowArrayViewP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow-array_1ga2014ebcd846b15b8f7a946bddaf9988c"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span class="pre">A [...]
+<dd><p>Initialize the contents of an <a class="reference internal"
href="#struct_arrow_array"><span class="std std-ref">ArrowArray</span></a> from
an <a class="reference internal" href="#struct_arrow_array_view"><span
class="std std-ref">ArrowArrayView</span></a>. </p>
+<p>Caller is responsible for calling the array->release callback if
NANOARROW_OK is returned. </p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv426ArrowArrayAllocateChildrenP10ArrowArray7int64_t">
<span
id="_CPPv326ArrowArrayAllocateChildrenP10ArrowArray7int64_t"></span><span
id="_CPPv226ArrowArrayAllocateChildrenP10ArrowArray7int64_t"></span><span
id="ArrowArrayAllocateChildren__ArrowArrayP.int64_t"></span><span
class="target"
id="group__nanoarrow-array_1ga2efc2f2831aabd24e3a894959206b770"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span class="w"> </span><span
class= [...]
diff --git a/dev/genindex.html b/dev/genindex.html
index 86204e2..1fa271c 100644
--- a/dev/genindex.html
+++ b/dev/genindex.html
@@ -413,6 +413,8 @@ document.write(`
<li><a
href="c.html#_CPPv423ArrowArrayFinishElementP10ArrowArray">ArrowArrayFinishElement
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv428ArrowArrayFinishUnionElementP10ArrowArray6int8_t">ArrowArrayFinishUnionElement
(C++ function)</a>
+</li>
+ <li><a
href="c.html#_CPPv427ArrowArrayInitFromArrayViewP10ArrowArrayP14ArrowArrayViewP10ArrowError">ArrowArrayInitFromArrayView
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv424ArrowArrayInitFromSchemaP10ArrowArrayP11ArrowSchemaP10ArrowError">ArrowArrayInitFromSchema
(C++ function)</a>
</li>
@@ -681,11 +683,11 @@ document.write(`
<li><a
href="ipc.html#_CPPv4N23ArrowIpcCompressionType35NANOARROW_IPC_COMPRESSION_TYPE_NONEE">ArrowIpcCompressionType::NANOARROW_IPC_COMPRESSION_TYPE_NONE
(C++ enumerator)</a>
</li>
<li><a
href="ipc.html#_CPPv4N23ArrowIpcCompressionType35NANOARROW_IPC_COMPRESSION_TYPE_ZSTDE">ArrowIpcCompressionType::NANOARROW_IPC_COMPRESSION_TYPE_ZSTD
(C++ enumerator)</a>
-</li>
- <li><a href="ipc.html#_CPPv415ArrowIpcDecoder">ArrowIpcDecoder (C++
struct)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="ipc.html#_CPPv415ArrowIpcDecoder">ArrowIpcDecoder (C++
struct)</a>
+</li>
<li><a
href="ipc.html#_CPPv4N15ArrowIpcDecoder15body_size_bytesE">ArrowIpcDecoder::body_size_bytes
(C++ member)</a>
</li>
<li><a
href="ipc.html#_CPPv4N15ArrowIpcDecoder5codecE">ArrowIpcDecoder::codec (C++
member)</a>
@@ -702,9 +704,11 @@ document.write(`
</li>
<li><a
href="ipc.html#_CPPv4N15ArrowIpcDecoder12private_dataE">ArrowIpcDecoder::private_data
(C++ member)</a>
</li>
- <li><a
href="ipc.html#_CPPv426ArrowIpcDecoderDecodeArrayP15ArrowIpcDecoder15ArrowBufferView7int64_tP10ArrowArrayP10ArrowError">ArrowIpcDecoderDecodeArray
(C++ function)</a>
+ <li><a
href="ipc.html#_CPPv426ArrowIpcDecoderDecodeArrayP15ArrowIpcDecoder15ArrowBufferView7int64_tP10ArrowArray20ArrowValidationLevelP10ArrowError">ArrowIpcDecoderDecodeArray
(C++ function)</a>
+</li>
+ <li><a
href="ipc.html#_CPPv436ArrowIpcDecoderDecodeArrayFromSharedP15ArrowIpcDecoderP20ArrowIpcSharedBuffer7int64_tP10ArrowArray20ArrowValidationLevelP10ArrowError">ArrowIpcDecoderDecodeArrayFromShared
(C++ function)</a>
</li>
- <li><a
href="ipc.html#_CPPv436ArrowIpcDecoderDecodeArrayFromSharedP15ArrowIpcDecoderP20ArrowIpcSharedBuffer7int64_tP10ArrowArrayP10ArrowError">ArrowIpcDecoderDecodeArrayFromShared
(C++ function)</a>
+ <li><a
href="ipc.html#_CPPv430ArrowIpcDecoderDecodeArrayViewP15ArrowIpcDecoder15ArrowBufferView7int64_tPP14ArrowArrayViewP10ArrowError">ArrowIpcDecoderDecodeArrayView
(C++ function)</a>
</li>
<li><a
href="ipc.html#_CPPv427ArrowIpcDecoderDecodeHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError">ArrowIpcDecoderDecodeHeader
(C++ function)</a>
</li>
@@ -719,8 +723,6 @@ document.write(`
<li><a
href="ipc.html#_CPPv428ArrowIpcDecoderSetEndiannessP15ArrowIpcDecoder18ArrowIpcEndianness">ArrowIpcDecoderSetEndianness
(C++ function)</a>
</li>
<li><a
href="ipc.html#_CPPv424ArrowIpcDecoderSetSchemaP15ArrowIpcDecoderP11ArrowSchemaP10ArrowError">ArrowIpcDecoderSetSchema
(C++ function)</a>
-</li>
- <li><a
href="ipc.html#_CPPv428ArrowIpcDecoderValidateArrayP10ArrowArray20ArrowValidationLevelP10ArrowError">ArrowIpcDecoderValidateArray
(C++ function)</a>
</li>
<li><a
href="ipc.html#_CPPv427ArrowIpcDecoderVerifyHeaderP15ArrowIpcDecoder15ArrowBufferViewP10ArrowError">ArrowIpcDecoderVerifyHeader
(C++ function)</a>
</li>
diff --git a/dev/ipc.html b/dev/ipc.html
index 082362c..0f3b39d 100644
--- a/dev/ipc.html
+++ b/dev/ipc.html
@@ -560,7 +560,7 @@ document.write(`
<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><a
class="reference internal" href="c.html#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n" [...]
<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_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>In almost all cases this should be preceeded 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>
@@ -590,25 +590,26 @@ document.write(`
</dd></dl>
<dl class="cpp function">
-<dt class="sig sig-object cpp"
id="_CPPv426ArrowIpcDecoderDecodeArrayP15ArrowIpcDecoder15ArrowBufferView7int64_tP10ArrowArrayP10ArrowError">
-<span
id="_CPPv326ArrowIpcDecoderDecodeArrayP15ArrowIpcDecoder15ArrowBufferView7int64_tP10ArrowArrayP10ArrowError"></span><span
id="_CPPv226ArrowIpcDecoderDecodeArrayP15ArrowIpcDecoder15ArrowBufferView7int64_tP10ArrowArrayP10ArrowError"></span><span
id="ArrowIpcDecoderDecodeArray__ArrowIpcDecoderP.ArrowBufferView.int64_t.ArrowArrayP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow__ipc_1ga742cad95c7f6e42d1a1b284133cbfab6"></span><a
class="reference internal" href="c.html#_CP [...]
+<dt class="sig sig-object cpp"
id="_CPPv430ArrowIpcDecoderDecodeArrayViewP15ArrowIpcDecoder15ArrowBufferView7int64_tPP14ArrowArrayViewP10ArrowError">
+<span
id="_CPPv330ArrowIpcDecoderDecodeArrayViewP15ArrowIpcDecoder15ArrowBufferView7int64_tPP14ArrowArrayViewP10ArrowError"></span><span
id="_CPPv230ArrowIpcDecoderDecodeArrayViewP15ArrowIpcDecoder15ArrowBufferView7int64_tPP14ArrowArrayViewP10ArrowError"></span><span
id="ArrowIpcDecoderDecodeArrayView__ArrowIpcDecoderP.ArrowBufferView.int64_t.ArrowArrayViewPP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow__ipc_1ga44c0bdce39d396d80203ff3996892eed"></span><a
class="reference [...]
+<dd><p>Decode an ArrowArrayView. </p>
+<p>After a successful call to <a class="reference internal"
href="#group__nanoarrow__ipc_1gaa4ea4cae2cca86081b9279e481e4dab0"><span
class="std std-ref">ArrowIpcDecoderDecodeHeader()</span></a>, deserialize the
content of body into an internally-managed ArrowArrayView and return it. Note
that field index does not equate to column index if any columns contain nested
types. Use a value of -1 to decode the entire array into a struct. The
pointed-to ArrowArrayView is owned by the <a class="re [...]
+<p>For streams that match system endianness and do not use compression, this
operation will not perform any heap allocations; however, the buffers referred
to by the returned ArrowArrayView are only valid as long as the buffer referred
to by body stays valid. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv426ArrowIpcDecoderDecodeArrayP15ArrowIpcDecoder15ArrowBufferView7int64_tP10ArrowArray20ArrowValidationLevelP10ArrowError">
+<span
id="_CPPv326ArrowIpcDecoderDecodeArrayP15ArrowIpcDecoder15ArrowBufferView7int64_tP10ArrowArray20ArrowValidationLevelP10ArrowError"></span><span
id="_CPPv226ArrowIpcDecoderDecodeArrayP15ArrowIpcDecoder15ArrowBufferView7int64_tP10ArrowArray20ArrowValidationLevelP10ArrowError"></span><span
id="ArrowIpcDecoderDecodeArray__ArrowIpcDecoderP.ArrowBufferView.int64_t.ArrowArrayP.ArrowValidationLevel.ArrowErrorP"></span><span
class="target" id="group__nanoarrow__ipc_1gaeea86e5a170f0b713edba7 [...]
<dd><p>Decode an ArrowArray. </p>
<p>After a successful call to <a class="reference internal"
href="#group__nanoarrow__ipc_1gaa4ea4cae2cca86081b9279e481e4dab0"><span
class="std std-ref">ArrowIpcDecoderDecodeHeader()</span></a>, assemble an
ArrowArray given a message body and a field index. Note that field index does
not equate to column index if any columns contain nested types. Use a value of
-1 to decode the entire array into a struct. The caller is responsible for
releasing the array if NANOARROW_OK is returned.</p>
<p>Returns EINVAL if the decoder did not just decode a record batch message,
ENOTSUP if the message uses features not supported by this library, or or
NANOARROW_OK otherwise. </p>
</dd></dl>
<dl class="cpp function">
-<dt class="sig sig-object cpp"
id="_CPPv436ArrowIpcDecoderDecodeArrayFromSharedP15ArrowIpcDecoderP20ArrowIpcSharedBuffer7int64_tP10ArrowArrayP10ArrowError">
-<span
id="_CPPv336ArrowIpcDecoderDecodeArrayFromSharedP15ArrowIpcDecoderP20ArrowIpcSharedBuffer7int64_tP10ArrowArrayP10ArrowError"></span><span
id="_CPPv236ArrowIpcDecoderDecodeArrayFromSharedP15ArrowIpcDecoderP20ArrowIpcSharedBuffer7int64_tP10ArrowArrayP10ArrowError"></span><span
id="ArrowIpcDecoderDecodeArrayFromShared__ArrowIpcDecoderP.ArrowIpcSharedBufferP.int64_t.ArrowArrayP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow__ipc_1ga40bdc88183e82556e89e6e6e48137888"></spa [...]
+<dt class="sig sig-object cpp"
id="_CPPv436ArrowIpcDecoderDecodeArrayFromSharedP15ArrowIpcDecoderP20ArrowIpcSharedBuffer7int64_tP10ArrowArray20ArrowValidationLevelP10ArrowError">
+<span
id="_CPPv336ArrowIpcDecoderDecodeArrayFromSharedP15ArrowIpcDecoderP20ArrowIpcSharedBuffer7int64_tP10ArrowArray20ArrowValidationLevelP10ArrowError"></span><span
id="_CPPv236ArrowIpcDecoderDecodeArrayFromSharedP15ArrowIpcDecoderP20ArrowIpcSharedBuffer7int64_tP10ArrowArray20ArrowValidationLevelP10ArrowError"></span><span
id="ArrowIpcDecoderDecodeArrayFromShared__ArrowIpcDecoderP.ArrowIpcSharedBufferP.int64_t.ArrowArrayP.ArrowValidationLevel.ArrowErrorP"></span><span
class="target" id= [...]
<dd><p>Decode an ArrowArray from an owned buffer. </p>
-<p>This implementation takes advantage of the fact that it can avoid copying
individual buffers. In all cases the caller must <a class="reference internal"
href="#group__nanoarrow__ipc_1ga126d5828e975d2de0ef5dc1162a7085f"><span
class="std std-ref">ArrowIpcSharedBufferReset()</span></a> body after one or
more calls to <a class="reference internal"
href="#group__nanoarrow__ipc_1ga40bdc88183e82556e89e6e6e48137888"><span
class="std std-ref">ArrowIpcDecoderDecodeArrayFromShared()</span></a>. [...]
-</dd></dl>
-
-<dl class="cpp function">
-<dt class="sig sig-object cpp"
id="_CPPv428ArrowIpcDecoderValidateArrayP10ArrowArray20ArrowValidationLevelP10ArrowError">
-<span
id="_CPPv328ArrowIpcDecoderValidateArrayP10ArrowArray20ArrowValidationLevelP10ArrowError"></span><span
id="_CPPv228ArrowIpcDecoderValidateArrayP10ArrowArray20ArrowValidationLevelP10ArrowError"></span><span
id="ArrowIpcDecoderValidateArray__ArrowArrayP.ArrowValidationLevel.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow__ipc_1gaec27831bcc64af1ee92043418a89dd0f"></span><a
class="reference internal" href="c.html#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class= [...]
-<dd><p>Validate a decoded ArrowArray. </p>
-<p>Verifies buffer lengths and contents depending on validation_level. Users
are reccomended to use NANOARROW_VALIDATION_LEVEL_FULL as any lesser value may
result in some types of corrupted data crashing a process on read. </p>
+<p>This implementation takes advantage of the fact that it can avoid copying
individual buffers. In all cases the caller must <a class="reference internal"
href="#group__nanoarrow__ipc_1ga126d5828e975d2de0ef5dc1162a7085f"><span
class="std std-ref">ArrowIpcSharedBufferReset()</span></a> body after one or
more calls to <a class="reference internal"
href="#group__nanoarrow__ipc_1gaec39d82c6e5b112457e5adf42d0fd9d7"><span
class="std std-ref">ArrowIpcDecoderDecodeArrayFromShared()</span></a>. [...]
</dd></dl>
<dl class="cpp function">
@@ -643,7 +644,7 @@ document.write(`
<span id="_CPPv320ArrowIpcSharedBuffer"></span><span
id="_CPPv220ArrowIpcSharedBuffer"></span><span
id="ArrowIpcSharedBuffer"></span><span class="target"
id="struct_arrow_ipc_shared_buffer"></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">ArrowIpcSharedBuffer</span></span></span><a class="headerlink"
href="#_CPPv420ArrowIpcSharedBuffer" title="Permalink to this
definition">#</a><br /></dt>
<dd><div class="docutils container">
<em>#include <nanoarrow_ipc.h></em></div>
-<p>A structure representing a reference-counted buffer that may be passed to
<a class="reference internal"
href="#group__nanoarrow__ipc_1ga40bdc88183e82556e89e6e6e48137888"><span
class="std std-ref">ArrowIpcDecoderDecodeArrayFromShared()</span></a>. </p>
+<p>A structure representing a reference-counted buffer that may be passed to
<a class="reference internal"
href="#group__nanoarrow__ipc_1gaec39d82c6e5b112457e5adf42d0fd9d7"><span
class="std std-ref">ArrowIpcDecoderDecodeArrayFromShared()</span></a>. </p>
</dd></dl>
<dl class="cpp struct">
diff --git a/dev/objects.inv b/dev/objects.inv
index c2878ef..c68218c 100644
Binary files a/dev/objects.inv and b/dev/objects.inv differ
diff --git a/dev/r/pkgdown.yml b/dev/r/pkgdown.yml
index 209b139..1021d21 100644
--- a/dev/r/pkgdown.yml
+++ b/dev/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.9.2.1
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
-last_built: 2023-06-06T01:48Z
+last_built: 2023-06-06T15:21Z
diff --git a/dev/searchindex.js b/dev/searchindex.js
index 10907ea..523af2a 100644
--- a/dev/searchindex.js
+++ b/dev/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["c", "cpp", "getting-started",
"getting-started_generated", "index", "ipc"], "filenames": ["c.rst", "cpp.rst",
"getting-started.rst", "getting-started_generated.rst", "index.rst",
"ipc.rst"], "titles": ["C API Reference", "C++ API Reference", "Getting started
with nanoarrow", "Getting started with nanoarrow", "nanoarrow", "IPC Extension
Reference"], "terms": {"group": [0, 1, 5], "nanoarrow": [0, 1, 5], "except":
[0, 1, 2, 3, 5], "where": [0, 1, 4, 5], "note" [...]
\ No newline at end of file
+Search.setIndex({"docnames": ["c", "cpp", "getting-started",
"getting-started_generated", "index", "ipc"], "filenames": ["c.rst", "cpp.rst",
"getting-started.rst", "getting-started_generated.rst", "index.rst",
"ipc.rst"], "titles": ["C API Reference", "C++ API Reference", "Getting started
with nanoarrow", "Getting started with nanoarrow", "nanoarrow", "IPC Extension
Reference"], "terms": {"group": [0, 1, 5], "nanoarrow": [0, 1, 5], "except":
[0, 1, 2, 3, 5], "where": [0, 1, 4, 5], "note" [...]
\ No newline at end of file
