This is an automated email from the ASF dual-hosted git repository.
github-actions[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 f3378bf2 update documentation for tag main
f3378bf2 is described below
commit f3378bf287595feb8773949b4537f914486f4d2a
Author: GitHub Actions <[email protected]>
AuthorDate: Sat Apr 18 02:53:27 2026 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1173470 -> 1173830 bytes
main/.doctrees/reference/ipc.doctree | Bin 361983 -> 378522 bytes
main/objects.inv | Bin 22973 -> 23078 bytes
main/r/pkgdown.yml | 2 +-
main/reference/ipc.html | 52 ++++++++++++++++++++++++++++++-----
main/searchindex.js | 2 +-
6 files changed, 47 insertions(+), 9 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 4ca9d929..af0d9b9d 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 cd0d568f..75852eec 100644
Binary files a/main/.doctrees/reference/ipc.doctree and
b/main/.doctrees/reference/ipc.doctree differ
diff --git a/main/objects.inv b/main/objects.inv
index 2bb7e998..7c661544 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 aadc2290..48848000 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,4 +2,4 @@ pandoc: 3.1.3
pkgdown: 2.2.0
pkgdown_sha: ~
articles: {}
-last_built: 2026-04-10T12:30Z
+last_built: 2026-04-18T02:53Z
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index f0f4286f..41062007 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -568,6 +568,12 @@
<dd><p>Append a given <a class="reference internal"
href="#struct_arrow_ipc_dictionary_encoding"><span class="std
std-ref">ArrowIpcDictionaryEncoding</span></a> to this list. </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow__ipc_1ga6609df508a1c7adc87c0b882bea922a8"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDictionaryEncodingsAppendSchema</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDictionaryEncodings</span>
<span class="pre">*dictionary_encodings,</span> <span class="pre">const</span>
<span class="pre">struct</span> <span class="pre">ArrowSchem [...]
+<dd><p>Append all dictionaries in schema identified according to a depth-first
recursive search starting at 0. </p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp">
<span class="target"
id="group__nanoarrow__ipc_1gad96d56b20ad02a5cb1525d296aaee4d1"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">const</span> <span class="pre">struct</span> <span
class="pre">ArrowIpcDictionaryEncoding</span> <span class="pre">*</span> <span
class="pre">ArrowIpcDictionaryEncodingsFind</span> <span
class="pre">(const</span> <span class="pre">struct</span> <span
class="pre">ArrowIpcDictionaryEncodings</span> <span class="p [...]
@@ -761,31 +767,63 @@
<dl class="cpp function">
<dt class="sig sig-object cpp">
-<span class="target"
id="group__nanoarrow__ipc_1ga18d488ad3732052ad499c8e540c069b7"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderDecodeArrayView</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDecoder</span> <span
class="pre">*decoder,</span> <span class="pre">struct</span> <span
class="pre">ArrowBufferView</span> <span class="pre">body,</span> <span
class="pre">int [...]
-<dd><p>Decode an <a class="reference internal"
href="c.html#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a>. </p>
+<span class="target"
id="group__nanoarrow__ipc_1ga48fd16de2be70041376a8ce0c96fccd0"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderDecodeArrayViewWithDictionaries</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDecoder</span> <span
class="pre">*decoder,</span> <span class="pre">struct</span> <span
class="pre">ArrowBufferView</span> <span class="pre">body,</span> <span [...]
+<dd><p>Decode an <a class="reference internal"
href="c.html#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a> with dictionary decoding support. </p>
<p>After a successful call to <a class="reference internal"
href="#group__nanoarrow__ipc_1ga7a0b784166e614901e2818d2a29a95dc"><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">
-<span class="target"
id="group__nanoarrow__ipc_1gad011d3c21576e51ec713e128964c5008"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderDecodeArray</span> <span class="pre">(struct</span>
<span class="pre">ArrowIpcDecoder</span> <span class="pre">*decoder,</span>
<span class="pre">struct</span> <span class="pre">ArrowBufferView</span> <span
class="pre">body,</span> <span class="pre">int64_t [...]
-<dd><p>Decode an <a class="reference internal"
href="c.html#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a>. </p>
+<span class="target"
id="group__nanoarrow__ipc_1ga18d488ad3732052ad499c8e540c069b7"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderDecodeArrayView</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDecoder</span> <span
class="pre">*decoder,</span> <span class="pre">struct</span> <span
class="pre">ArrowBufferView</span> <span class="pre">body,</span> <span
class="pre">int [...]
+<dd><p>Decode an <a class="reference internal"
href="c.html#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a> without dictionary decoding. </p>
+<p>After a successful call to <a class="reference internal"
href="#group__nanoarrow__ipc_1ga7a0b784166e614901e2818d2a29a95dc"><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.</p>
+<p>This is equivalent to <a class="reference internal"
href="#group__nanoarrow__ipc_1ga48fd16de2be70041376a8ce0c96fccd0"><span
class="std std-ref">ArrowIpcDecoderDecodeArrayViewWithDictionaries()</span></a>
passing dictionaries as NULL. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow__ipc_1ga016dbf761719c7b085d793bc569165e6"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderDecodeArrayWithDictionaries</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDecoder</span> <span
class="pre">*decoder,</span> <span class="pre">struct</span> <span
class="pre">ArrowBufferView</span> <span class="pre">body,</span> <span cla
[...]
+<dd><p>Decode an <a class="reference internal"
href="c.html#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a> with dictionary decoding support. </p>
<p>After a successful call to <a class="reference internal"
href="#group__nanoarrow__ipc_1ga7a0b784166e614901e2818d2a29a95dc"><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">
+<span class="target"
id="group__nanoarrow__ipc_1gad011d3c21576e51ec713e128964c5008"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderDecodeArray</span> <span class="pre">(struct</span>
<span class="pre">ArrowIpcDecoder</span> <span class="pre">*decoder,</span>
<span class="pre">struct</span> <span class="pre">ArrowBufferView</span> <span
class="pre">body,</span> <span class="pre">int64_t [...]
+<dd><p>Decode an <a class="reference internal"
href="c.html#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a> without dictionary decoding support. </p>
+<p>After a successful call to <a class="reference internal"
href="#group__nanoarrow__ipc_1ga7a0b784166e614901e2818d2a29a95dc"><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.</p>
+<p>This is equivalent to calling <a class="reference internal"
href="#group__nanoarrow__ipc_1ga016dbf761719c7b085d793bc569165e6"><span
class="std std-ref">ArrowIpcDecoderDecodeArrayWithDictionaries()</span></a>
passing dictionaries as NULL. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow__ipc_1ga2f01bcf23bc41ef82b258a0ffd6a0706"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderDecodeArrayFromSharedWithDictionaries</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDecoder</span> <span
class="pre">*decoder,</span> <span class="pre">struct</span> <span
class="pre">ArrowIpcSharedBuffer</span> <span class="pre">*shared [...]
+<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 with dictionary decoding
support. </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_1ga4271f51dd56896bb76770dcb4084fbbe"><span
class="std std-ref">ArrowIpcSharedBufferReset()</span></a> body after one or
more calls to <a class="reference internal"
href="#group__nanoarrow__ipc_1gadd4ab41285a9a217664286b6abba0037"><span
class="std std-ref">ArrowIpcDecoderDecodeArrayFromShared()</span></a>. [...]
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp">
<span class="target"
id="group__nanoarrow__ipc_1gadd4ab41285a9a217664286b6abba0037"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderDecodeArrayFromShared</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDecoder</span> <span
class="pre">*decoder,</span> <span class="pre">struct</span> <span
class="pre">ArrowIpcSharedBuffer</span> <span class="pre">*shared,</span> <span
c [...]
<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_1ga4271f51dd56896bb76770dcb4084fbbe"><span
class="std std-ref">ArrowIpcSharedBufferReset()</span></a> body after one or
more calls to <a class="reference internal"
href="#group__nanoarrow__ipc_1gadd4ab41285a9a217664286b6abba0037"><span
class="std std-ref">ArrowIpcDecoderDecodeArrayFromShared()</span></a>. [...]
+<p>Equivalent to calling <a class="reference internal"
href="#group__nanoarrow__ipc_1ga2f01bcf23bc41ef82b258a0ffd6a0706"><span
class="std
std-ref">ArrowIpcDecoderDecodeArrayFromSharedWithDictionaries()</span></a> with
dictionaries as NULL. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp">
-<span class="target"
id="group__nanoarrow__ipc_1ga0c96fd00412554c2ed9fe9257dde2498"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderDecodeDictionary</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDecoder</span> <span
class="pre">*decoder,</span> <span class="pre">struct</span> <span
class="pre">ArrowIpcSharedBuffer</span> <span class="pre">*shared,</span> <span
class= [...]
-<dd></dd></dl>
+<span class="target"
id="group__nanoarrow__ipc_1gae648bc374db5d290211cf36960c2877f"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderDecodeDictionary</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDecoder</span> <span
class="pre">*decoder,</span> <span class="pre">struct</span> <span
class="pre">ArrowBufferView</span> <span class="pre">body,</span> <span
class="pre">en [...]
+<dd><p>Decode an <a class="reference internal"
href="c.html#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a> from a dictionary batch into the given <a
class="reference internal" href="#struct_arrow_ipc_dictionaries"><span
class="std std-ref">ArrowIpcDictionaries</span></a>. </p>
+<p>After a successful call to <a class="reference internal"
href="#group__nanoarrow__ipc_1ga7a0b784166e614901e2818d2a29a95dc"><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 and place it into out for the decoding of
future dictionaries. Note that other dictionaries in out may be used during the
decoding if there are nested dictionaries in th [...]
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow__ipc_1ga5e1e79c9c13f127c763befe8880074c4"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderDecodeDictionaryFromShared</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDecoder</span> <span
class="pre">*decoder,</span> <span class="pre">struct</span> <span
class="pre">ArrowIpcSharedBuffer</span> <span class="pre">*shared,</span> <s
[...]
+<dd><p>Decode an <a class="reference internal"
href="c.html#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a> from a dictionary batch 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_1ga4271f51dd56896bb76770dcb4084fbbe"><span
class="std std-ref">ArrowIpcSharedBufferReset()</span></a> body after one or
more calls to <a class="reference internal"
href="#group__nanoarrow__ipc_1gadd4ab41285a9a217664286b6abba0037"><span
class="std std-ref">ArrowIpcDecoderDecodeArrayFromShared()</span></a>. [...]
+</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp">
diff --git a/main/searchindex.js b/main/searchindex.js
index 8016bd8d..7903ab58 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
