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 c58ce345 update documentation for tag main
c58ce345 is described below
commit c58ce345496a0bb8bbad31f8a8e379840bdb993d
Author: GitHub Actions <[email protected]>
AuthorDate: Tue Sep 8 17:40:08 2026 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1176988 -> 1177132 bytes
main/.doctrees/reference/ipc.doctree | Bin 389692 -> 394793 bytes
main/objects.inv | Bin 23152 -> 23198 bytes
main/r/pkgdown.yml | 2 +-
main/reference/ipc.html | 16 ++++++++++++++++
main/searchindex.js | 2 +-
6 files changed, 18 insertions(+), 2 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 08f1e21e..dbcc6714 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 06e7ad8e..66d74fb4 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 d8d2b349..0f77609c 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 5c3d5c31..ac863aba 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,4 +2,4 @@ pandoc: 3.7.0.2
pkgdown: 2.2.1
pkgdown_sha: ~
articles: {}
-last_built: 2026-09-06T03:14Z
+last_built: 2026-09-08T17:39Z
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index 5144c0fc..dd3c3efe 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -924,6 +924,14 @@
<p>Returns ENOMEM if allocation fails, NANOARROW_OK otherwise. </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow__ipc_1gaead4027cadb01eab3467726abd8e0688"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcEncoderEncodeSimpleDictionaryBatch</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcEncoder</span> <span
class="pre">*encoder,</span> <span class="pre">int64_t</span> <span
class="pre">dictionary_id,</span> <span class="pre">char</span> <span clas [...]
+<dd><p>Encode an ArrayView as a DictionaryBatch flatbuffer, embedded in a
Message. </p>
+<p>dictionary_id must match the id assigned to the dictionary-encoded field in
the schema. is_delta selects DictionaryBatch.isDelta. values_view must not
itself be dictionary-encoded. Body buffers are concatenated into a contiguous,
padded body_buffer.</p>
+<p>Returns ENOMEM if allocation fails, EINVAL if values_view is
dictionary-encoded, NANOARROW_OK otherwise. </p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp">
<span class="target"
id="group__nanoarrow__ipc_1ga1d9a648fb5e3db463631a0210e2f393c"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">void</span> <span class="pre">ArrowIpcOutputStreamMove</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcOutputStream</span> <span
class="pre">*src,</span> <span class="pre">struct</span> <span
class="pre">ArrowIpcOutputStream</span> <span
class="pre">*dst)</span></span></dt>
@@ -978,6 +986,14 @@
<p>Errors are propagated from the underlying encoder and output byte stream,
</p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow__ipc_1gac56261b7cc2a81071b857895d64ba4ae"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcWriterWriteDictionaryBatch</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcWriter</span> <span
class="pre">*writer,</span> <span class="pre">int64_t</span> <span
class="pre">dictionary_id,</span> <span class="pre">char</span> <span
class="pre">is [...]
+<dd><p>Write a DictionaryBatch message to the output byte stream. </p>
+<p>dictionary_id must match the id assigned to the dictionary-encoded field in
the schema. is_delta selects DictionaryBatch.isDelta. values_view must not
itself be dictionary-encoded. The writer does not check that a schema was
already written.</p>
+<p>Errors are propagated from the underlying encoder and output byte stream.
</p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp">
<span class="target"
id="group__nanoarrow__ipc_1ga64d014567e9db57a7ccdb6f423082087"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcWriterWriteArrayStream</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcWriter</span> <span
class="pre">*writer,</span> <span class="pre">struct</span> <span
class="pre">ArrowArrayStream</span> <span class="pre">*in,</span> <span
class="pre">struc [...]
diff --git a/main/searchindex.js b/main/searchindex.js
index 27ce8fe7..2e11a17b 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
