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 12f64dd9 update documentation for tag main
12f64dd9 is described below
commit 12f64dd9687258c1e408752be0c9883fbc1967ec
Author: GitHub Actions <[email protected]>
AuthorDate: Mon Jun 10 19:42:46 2024 +0000
update documentation for tag main
---
main/r/pkgdown.yml | 2 +-
main/reference/ipc.html | 26 +++++++++++++-------------
2 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index 85c10970..bd9e30d6 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 3.1.3
pkgdown: 2.0.9
pkgdown_sha: ~
articles: {}
-last_built: 2024-06-10T19:35Z
+last_built: 2024-06-10T19:42Z
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index 7abd43b2..a3d5d451 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -562,7 +562,7 @@ document.write(`
<dt class="sig sig-object cpp"
id="_CPPv425ArrowIpcSharedBufferResetP20ArrowIpcSharedBuffer">
<span
id="_CPPv325ArrowIpcSharedBufferResetP20ArrowIpcSharedBuffer"></span><span
id="_CPPv225ArrowIpcSharedBufferResetP20ArrowIpcSharedBuffer"></span><span
id="ArrowIpcSharedBufferReset__ArrowIpcSharedBufferP"></span><span
class="target"
id="group__nanoarrow__ipc_1ga126d5828e975d2de0ef5dc1162a7085f"></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">ArrowIpcSharedBufferReset</span></span></ [...]
<dd><p>Release the caller’s copy of the shared buffer. </p>
-<p>When finished, the caller must relinquish its own copy of the shared data
using this function. The original buffer will continue to exist until all
ArrowArray objects that refer to it have also been released. </p>
+<p>When finished, the caller must relinquish its own copy of the shared data
using this function. The original buffer will continue to exist until all <a
class="reference internal" href="c.html#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a> objects that refer to it have also been
released. </p>
</dd></dl>
<dl class="cpp function">
@@ -611,15 +611,15 @@ document.write(`
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv427ArrowIpcDecoderDecodeSchemaP15ArrowIpcDecoderP11ArrowSchemaP10ArrowError">
<span
id="_CPPv327ArrowIpcDecoderDecodeSchemaP15ArrowIpcDecoderP11ArrowSchemaP10ArrowError"></span><span
id="_CPPv227ArrowIpcDecoderDecodeSchemaP15ArrowIpcDecoderP11ArrowSchemaP10ArrowError"></span><span
id="ArrowIpcDecoderDecodeSchema__ArrowIpcDecoderP.ArrowSchemaP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow__ipc_1gab56730acfeaad71f0b31e0616c3cac02"></span><a
class="reference internal" href="c.html#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span cl [...]
-<dd><p>Decode an ArrowSchema. </p>
-<p>After a successful call to <a class="reference internal"
href="#group__nanoarrow__ipc_1gaa4ea4cae2cca86081b9279e481e4dab0"><span
class="std std-ref">ArrowIpcDecoderDecodeHeader()</span></a>, retrieve an
ArrowSchema. The caller is responsible for releasing the schema if NANOARROW_OK
is returned.</p>
+<dd><p>Decode an <a class="reference internal"
href="c.html#struct_arrow_schema"><span class="std
std-ref">ArrowSchema</span></a>. </p>
+<p>After a successful call to <a class="reference internal"
href="#group__nanoarrow__ipc_1gaa4ea4cae2cca86081b9279e481e4dab0"><span
class="std std-ref">ArrowIpcDecoderDecodeHeader()</span></a>, retrieve an <a
class="reference internal" href="c.html#struct_arrow_schema"><span class="std
std-ref">ArrowSchema</span></a>. The caller is responsible for releasing the
schema if NANOARROW_OK is returned.</p>
<p>Returns EINVAL if the decoder did not just decode a schema message or
NANOARROW_OK otherwise. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv424ArrowIpcDecoderSetSchemaP15ArrowIpcDecoderP11ArrowSchemaP10ArrowError">
<span
id="_CPPv324ArrowIpcDecoderSetSchemaP15ArrowIpcDecoderP11ArrowSchemaP10ArrowError"></span><span
id="_CPPv224ArrowIpcDecoderSetSchemaP15ArrowIpcDecoderP11ArrowSchemaP10ArrowError"></span><span
id="ArrowIpcDecoderSetSchema__ArrowIpcDecoderP.ArrowSchemaP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow__ipc_1ga91e04e3442fdf80c7097693d27b41d2f"></span><a
class="reference internal" href="c.html#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span class="pre" [...]
-<dd><p>Set the ArrowSchema used to decode future record batch messages. </p>
+<dd><p>Set the <a class="reference internal"
href="c.html#struct_arrow_schema"><span class="std
std-ref">ArrowSchema</span></a> used to decode future record batch messages.
</p>
<p>Prepares the decoder for future record batch messages of this type. The
decoder takes ownership of schema if NANOARROW_OK is returned. Note that you
must call this explicitly after decoding a Schema message (i.e., the decoder
does not assume that the last-decoded schema message applies to future record
batch messages).</p>
<p>Returns EINVAL if schema validation fails or NANOARROW_OK otherwise. </p>
</dd></dl>
@@ -635,23 +635,23 @@ document.write(`
<dl class="cpp function">
<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><p>Decode an <a class="reference internal"
href="c.html#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a>. </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 <a class="reference internal"
href="c.html#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a> and return it. Note that field index does
not equate to column index if any columns contain nested types. Use a value o
[...]
+<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 <a class="reference internal"
href="c.html#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a> 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>
+<dd><p>Decode an <a class="reference internal"
href="c.html#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a>. </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 <a
class="reference internal" href="c.html#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a> 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 [...]
<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_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>
+<dd><p>Decode an <a class="reference internal"
href="c.html#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a> 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_1gaec39d82c6e5b112457e5adf42d0fd9d7"><span
class="std std-ref">ArrowIpcDecoderDecodeArrayFromShared()</span></a>. [...]
</dd></dl>
@@ -664,7 +664,7 @@ document.write(`
<dl class="cpp function">
<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><a
class="reference internal" href="c.html#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span class="pre">ArrowError [...]
-<dd><p>Create an input stream from an ArrowBuffer. </p>
+<dd><p>Create an input stream from an <a class="reference internal"
href="c.html#struct_arrow_buffer"><span class="std
std-ref">ArrowBuffer</span></a>. </p>
</dd></dl>
<dl class="cpp function">
@@ -677,8 +677,8 @@ document.write(`
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv429ArrowIpcArrayStreamReaderInitP16ArrowArrayStreamP19ArrowIpcInputStreamP32ArrowIpcArrayStreamReaderOptions">
<span
id="_CPPv329ArrowIpcArrayStreamReaderInitP16ArrowArrayStreamP19ArrowIpcInputStreamP32ArrowIpcArrayStreamReaderOptions"></span><span
id="_CPPv229ArrowIpcArrayStreamReaderInitP16ArrowArrayStreamP19ArrowIpcInputStreamP32ArrowIpcArrayStreamReaderOptions"></span><span
id="ArrowIpcArrayStreamReaderInit__ArrowArrayStreamP.ArrowIpcInputStreamP.ArrowIpcArrayStreamReaderOptionsP"></span><span
class="target"
id="group__nanoarrow__ipc_1ga0afe677c571f9bc37449178940392496"></span><a
class="refer [...]
-<dd><p>Initialize an ArrowArrayStream from an input stream of bytes. </p>
-<p>The stream of bytes must begin with a Schema message and be followed by
zero or more RecordBatch messages as described in the Arrow IPC stream format
specification. Returns NANOARROW_OK on success. If NANOARROW_OK is returned,
the ArrowArrayStream takes ownership of input_stream and the caller is
responsible for releasing out. </p>
+<dd><p>Initialize an <a class="reference internal"
href="c.html#struct_arrow_array_stream"><span class="std
std-ref">ArrowArrayStream</span></a> from an input stream of bytes. </p>
+<p>The stream of bytes must begin with a Schema message and be followed by
zero or more RecordBatch messages as described in the Arrow IPC stream format
specification. Returns NANOARROW_OK on success. If NANOARROW_OK is returned,
the <a class="reference internal" href="c.html#struct_arrow_array_stream"><span
class="std std-ref">ArrowArrayStream</span></a> takes ownership of input_stream
and the caller is responsible for releasing out. </p>
</dd></dl>
</div>
