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 b6c9d5e8 update documentation for tag main
b6c9d5e8 is described below
commit b6c9d5e88f9583760e3bf402bd5b65442b209b05
Author: GitHub Actions <[email protected]>
AuthorDate: Mon Mar 23 13:52:26 2026 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1155471 -> 1169640 bytes
main/.doctrees/reference/ipc.doctree | Bin 303291 -> 343189 bytes
main/genindex.html | 26 ++++++--
main/objects.inv | Bin 22361 -> 22806 bytes
main/r/pkgdown.yml | 2 +-
main/reference/ipc.html | 125 ++++++++++++++++++++++++++++++++++-
main/searchindex.js | 2 +-
7 files changed, 146 insertions(+), 9 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 4e32945a..2a515703 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 ac2bf21c..4dddd420 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 7bafee13..32654128 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -750,8 +750,6 @@
</li>
<li><a
href="reference/device.html#_CPPv4N11ArrowDevice17synchronize_eventE">ArrowDevice::synchronize_event
(C++ member)</a>
</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/device.html#_CPPv416ArrowDeviceArray">ArrowDeviceArray (C++
struct)</a>
</li>
<li><a
href="reference/device.html#_CPPv4N16ArrowDeviceArray5arrayE">ArrowDeviceArray::array
(C++ member)</a>
@@ -760,6 +758,8 @@
</li>
<li><a
href="reference/device.html#_CPPv4N16ArrowDeviceArray11device_typeE">ArrowDeviceArray::device_type
(C++ member)</a>
</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/device.html#_CPPv4N16ArrowDeviceArray8reservedE">ArrowDeviceArray::reserved
(C++ member)</a>
</li>
<li><a
href="reference/device.html#_CPPv4N16ArrowDeviceArray10sync_eventE">ArrowDeviceArray::sync_event
(C++ member)</a>
@@ -877,6 +877,22 @@
<li><a
href="reference/ipc.html#_CPPv4N23ArrowIpcDictionaryBatch2idE">ArrowIpcDictionaryBatch::id
(C++ member)</a>
</li>
<li><a
href="reference/ipc.html#_CPPv4N23ArrowIpcDictionaryBatch8is_deltaE">ArrowIpcDictionaryBatch::is_delta
(C++ member)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv426ArrowIpcDictionaryEncoding">ArrowIpcDictionaryEncoding
(C++ struct)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv4N26ArrowIpcDictionaryEncoding2idE">ArrowIpcDictionaryEncoding::id
(C++ member)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv4N26ArrowIpcDictionaryEncoding4kindE">ArrowIpcDictionaryEncoding::kind
(C++ member)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv4N26ArrowIpcDictionaryEncoding6schemaE">ArrowIpcDictionaryEncoding::schema
(C++ member)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv427ArrowIpcDictionaryEncodings">ArrowIpcDictionaryEncodings
(C++ struct)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv422ArrowIpcDictionaryKind">ArrowIpcDictionaryKind
(C++ enum)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv4N22ArrowIpcDictionaryKind41NANOARROW_IPC_DICTIONARY_KIND_DENSE_ARRAYE">ArrowIpcDictionaryKind::NANOARROW_IPC_DICTIONARY_KIND_DENSE_ARRAY
(C++ enumerator)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv4N22ArrowIpcDictionaryKind43NANOARROW_IPC_DICTIONARY_KIND_UNINITIALIZEDE">ArrowIpcDictionaryKind::NANOARROW_IPC_DICTIONARY_KIND_UNINITIALIZED
(C++ enumerator)</a>
</li>
<li><a href="reference/ipc.html#_CPPv415ArrowIpcEncoder">ArrowIpcEncoder
(C++ struct)</a>
</li>
@@ -1662,15 +1678,17 @@
</li>
<li><a
href="reference/ipc.html#_CPPv418UniqueDecompressor">UniqueDecompressor (C++
type)</a>
</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="reference/device.html#_CPPv412UniqueDevice">UniqueDevice
(C++ type)</a>
</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="reference/device.html#_CPPv417UniqueDeviceArray">UniqueDeviceArray (C++
type)</a>
</li>
<li><a
href="reference/device.html#_CPPv423UniqueDeviceArrayStream">UniqueDeviceArrayStream
(C++ type)</a>
</li>
<li><a
href="reference/device.html#_CPPv421UniqueDeviceArrayView">UniqueDeviceArrayView
(C++ type)</a>
+</li>
+ <li><a
href="reference/ipc.html#_CPPv425UniqueDictionaryEncodings">UniqueDictionaryEncodings
(C++ type)</a>
</li>
<li><a href="reference/ipc.html#_CPPv413UniqueEncoder">UniqueEncoder
(C++ type)</a>
</li>
diff --git a/main/objects.inv b/main/objects.inv
index 72de66e3..5f00ad1a 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 446dbc18..b76bad9b 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-03-06T14:47Z
+last_built: 2026-03-23T13:51Z
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index b455239f..2bcd0b1c 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -530,9 +530,51 @@
</dd></dl>
+<dl class="cpp enum">
+<dt class="sig sig-object cpp" id="_CPPv422ArrowIpcDictionaryKind">
+<span id="_CPPv322ArrowIpcDictionaryKind"></span><span
id="_CPPv222ArrowIpcDictionaryKind"></span><span class="target"
id="group__nanoarrow__ipc_1gab9971c1fa0909cdeef2f96374e4e7937"></span><span
class="k"><span class="pre">enum</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">ArrowIpcDictionaryKind</span></span></span><a class="headerlink"
href="#_CPPv422ArrowIpcDictionaryKind" title="Link to this definition">#</a><br
/></dt>
+<dd><p>Dictionary kind enumerator. </p>
+<p><em>Values:</em></p>
+<dl class="cpp enumerator">
+<dt class="sig sig-object cpp"
id="_CPPv4N22ArrowIpcDictionaryKind43NANOARROW_IPC_DICTIONARY_KIND_UNINITIALIZEDE">
+<span
id="_CPPv3N22ArrowIpcDictionaryKind43NANOARROW_IPC_DICTIONARY_KIND_UNINITIALIZEDE"></span><span
id="_CPPv2N22ArrowIpcDictionaryKind43NANOARROW_IPC_DICTIONARY_KIND_UNINITIALIZEDE"></span><span
class="target"
id="group__nanoarrow__ipc_1ggab9971c1fa0909cdeef2f96374e4e7937a4e1e8340943e45e32e2589ee6c629f3d"></span><span
class="k"><span class="pre">enumerator</span></span><span class="w">
</span><span class="sig-name descname"><span class="n"><span
class="pre">NANOARROW_IPC_DICTIONARY_KI [...]
+<dd></dd></dl>
+
+<dl class="cpp enumerator">
+<dt class="sig sig-object cpp"
id="_CPPv4N22ArrowIpcDictionaryKind41NANOARROW_IPC_DICTIONARY_KIND_DENSE_ARRAYE">
+<span
id="_CPPv3N22ArrowIpcDictionaryKind41NANOARROW_IPC_DICTIONARY_KIND_DENSE_ARRAYE"></span><span
id="_CPPv2N22ArrowIpcDictionaryKind41NANOARROW_IPC_DICTIONARY_KIND_DENSE_ARRAYE"></span><span
class="target"
id="group__nanoarrow__ipc_1ggab9971c1fa0909cdeef2f96374e4e7937a77d94153c2bde27f9ce11266713ac445"></span><span
class="k"><span class="pre">enumerator</span></span><span class="w">
</span><span class="sig-name descname"><span class="n"><span
class="pre">NANOARROW_IPC_DICTIONARY_KIND_D [...]
+<dd></dd></dl>
+
+</dd></dl>
+
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-functions">Functions</p>
+<dl class="cpp function">
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow__ipc_1ga53c67de4e3bac4dd3f897c5d34489db5"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">void</span> <span
class="pre">ArrowIpcDictionaryEncodingsInit</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDictionaryEncodings</span>
<span class="pre">*dictionaries)</span></span></dt>
+<dd><p>Initialize an <a class="reference internal"
href="#struct_arrow_ipc_dictionary_encodings"><span class="std
std-ref">ArrowIpcDictionaryEncodings</span></a> list. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow__ipc_1gace746f3d986cc443ae187f53788165da"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDictionaryEncodingsAppend</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDictionaryEncodings</span>
<span class="pre">*dictionaries,</span> <span class="pre">struct</span> <span
class="pre">ArrowIpcDictionaryEncoding</span> <span class="pre">enc [...]
+<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_1ga702c7c97263cfcd89cf5b160aa3afc1b"></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 [...]
+<dd><p>Resolve a <a class="reference internal"
href="#struct_arrow_ipc_dictionary_encoding"><span class="std
std-ref">ArrowIpcDictionaryEncoding</span></a> for a given dictionary encoded
field. </p>
+<p>Returns NULL if the pointed to schema does not match any of the pointed to
schemas contained in this list. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow__ipc_1gad45c65a7ca79aa1fc6fa1f8f900e217b"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">void</span> <span
class="pre">ArrowIpcDictionaryEncodingsReset</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDictionaryEncodings</span>
<span class="pre">*dictionaries)</span></span></dt>
+<dd><p>Release an encodings list and associated resources. </p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp">
<span class="target"
id="group__nanoarrow__ipc_1ga7228d11cc56a1e2f16d286ede17431e8"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span class="pre">ArrowIpcCheckRuntime</span>
<span class="pre">(struct</span> <span class="pre">ArrowError</span> <span
class="pre">*error)</span></span></dt>
@@ -640,18 +682,35 @@
<dt class="sig sig-object cpp">
<span class="target"
id="group__nanoarrow__ipc_1ga6537fc8201e2db40f973bd98ea609a8d"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderDecodeSchema</span> <span class="pre">(struct</span>
<span class="pre">ArrowIpcDecoder</span> <span class="pre">*decoder,</span>
<span class="pre">struct</span> <span class="pre">ArrowSchema</span> <span
class="pre">*out,</span> <span class="pre">struct</sp [...]
<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_1ga7a0b784166e614901e2818d2a29a95dc"><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>After a successful call to <a class="reference internal"
href="#group__nanoarrow__ipc_1ga7a0b784166e614901e2818d2a29a95dc"><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. This is equivalent to calling <a
class="reference internal" href="#group__nanoarrow__ipc_1ga [...]
+<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">
+<span class="target"
id="group__nanoarrow__ipc_1ga784c9f6de50cf1feb44c2e7c48e4e54c"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderDecodeSchemaWithDictionaries</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDecoder</span> <span
class="pre">*decoder,</span> <span class="pre">struct</span> <span
class="pre">ArrowSchema</span> <span class="pre">*out,</span> <span class= [...]
+<dd><p>Decode an <a class="reference internal"
href="c.html#struct_arrow_schema"><span class="std
std-ref">ArrowSchema</span></a> with dictionary encoding information. </p>
+<p>After a successful call to <a class="reference internal"
href="#group__nanoarrow__ipc_1ga7a0b784166e614901e2818d2a29a95dc"><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. Neither out nor dictionaries_out should be
initialized; dictionaries_out may be null to omit [...]
<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">
-<span class="target"
id="group__nanoarrow__ipc_1ga36e8548b5024a0850815f6e1f88b0043"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderSetSchema</span> <span class="pre">(struct</span>
<span class="pre">ArrowIpcDecoder</span> <span class="pre">*decoder,</span>
<span class="pre">struct</span> <span class="pre">ArrowSchema</span> <span
class="pre">*schema,</span> <span class="pre">struct</sp [...]
+<span class="target"
id="group__nanoarrow__ipc_1ga3b1b3328e874cb2a55cc08b988921254"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderSetSchema</span> <span class="pre">(struct</span>
<span class="pre">ArrowIpcDecoder</span> <span class="pre">*decoder,</span>
<span class="pre">const</span> <span class="pre">struct</span> <span
class="pre">ArrowSchema</span> <span class="pre">*schema,</spa [...]
<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>Prepares the decoder for future record batch messages of this type. The
decoder does not take ownership of schema. 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>This is equivalent to calling <a class="reference internal"
href="#group__nanoarrow__ipc_1gab7abcb2cb0abd63916638d38cda46b77"><span
class="std std-ref">ArrowIpcDecoderSetSchemaWithDictionaries()</span></a> with
dictionary_encodings = NULL.</p>
<p>Returns EINVAL if schema validation fails or NANOARROW_OK otherwise. </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow__ipc_1gab7abcb2cb0abd63916638d38cda46b77"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderSetSchemaWithDictionaries</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDecoder</span> <span
class="pre">*decoder,</span> <span class="pre">const</span> <span
class="pre">struct</span> <span class="pre">ArrowSchema</span> <span class="pr
[...]
+<dd><p>Set the <a class="reference internal"
href="c.html#struct_arrow_schema"><span class="std
std-ref">ArrowSchema</span></a> and dictionary encodings used to decode future
record batch messages. </p>
+<p>Prepares the decoder for future record batch messages of this type. The
decoder does not take ownership of schema. 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 if the schema contains
dictionary encodings that could not be resolved in the provided <a
class="reference internal" href="#struct_arrow_ipc_dictionary_encodings"><span
class="std std-ref">ArrowIpcDictionaryEncodings</span></a> object, or
NANOARROW_OK otherwise. </p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp">
<span class="target"
id="group__nanoarrow__ipc_1ga111a0e8a643d70003f9601a43ff85207"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcDecoderSetEndianness</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcDecoder</span> <span
class="pre">*decoder,</span> <span class="pre">enum</span> <span
class="pre">ArrowIpcEndianness</span> <span
class="pre">endianness)</span></span></dt>
@@ -845,6 +904,47 @@
</div>
</dd></dl>
+<dl class="cpp struct">
+<dt class="sig sig-object cpp" id="_CPPv426ArrowIpcDictionaryEncoding">
+<span id="_CPPv326ArrowIpcDictionaryEncoding"></span><span
id="_CPPv226ArrowIpcDictionaryEncoding"></span><span
id="ArrowIpcDictionaryEncoding"></span><span class="target"
id="struct_arrow_ipc_dictionary_encoding"></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">ArrowIpcDictionaryEncoding</span></span></span><a
class="headerlink" href="#_CPPv426ArrowIpcDictionaryEncoding" title="Link to
[...]
+<dd><div class="docutils container">
+<em>#include <nanoarrow_ipc.h></em></div>
+<p>Description of a dictionary-encoded field. </p>
+<p>This struct is intended to be passed by value; however, its data is
invalidated if the underlying <a class="reference internal"
href="c.html#struct_arrow_schema"><span class="std
std-ref">ArrowSchema</span></a> that contains the dictionary-encoded field is
released. </p>
+<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">
+<dt class="sig sig-object cpp"
id="_CPPv4N26ArrowIpcDictionaryEncoding6schemaE">
+<span id="_CPPv3N26ArrowIpcDictionaryEncoding6schemaE"></span><span
id="_CPPv2N26ArrowIpcDictionaryEncoding6schemaE"></span><span
id="ArrowIpcDictionaryEncoding::schema__ArrowSchemaCP"></span><span
class="target"
id="struct_arrow_ipc_dictionary_encoding_1a6c1f012ce5ebd4859f7b14d3e7d2b3f8"></span><span
class="k"><span class="pre">const</span></span><span class="w"> </span><span
class="k"><span class="pre">struct</span></span><span class="w"> </span><a
class="reference internal" href="c.ht [...]
+<dd><p>A pointer to the <a class="reference internal"
href="c.html#struct_arrow_schema"><span class="std
std-ref">ArrowSchema</span></a> node of the dictionary-encoded field. </p>
+<p>This is a reference into another object and care must be taken to ensure
that if that object is copied that the schema pointers are updated
appropriately. </p>
+</dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N26ArrowIpcDictionaryEncoding2idE">
+<span id="_CPPv3N26ArrowIpcDictionaryEncoding2idE"></span><span
id="_CPPv2N26ArrowIpcDictionaryEncoding2idE"></span><span
id="ArrowIpcDictionaryEncoding::id__int64_t"></span><span class="target"
id="struct_arrow_ipc_dictionary_encoding_1a006a2dce4ef317ba8adf709c08ce7d80"></span><span
class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">id</span></span></span><a class="headerlink"
href="#_CPPv4N26ArrowIp [...]
+<dd><p>The identifier used that will appear in dictionary batch messages. </p>
+</dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N26ArrowIpcDictionaryEncoding4kindE">
+<span id="_CPPv3N26ArrowIpcDictionaryEncoding4kindE"></span><span
id="_CPPv2N26ArrowIpcDictionaryEncoding4kindE"></span><span
id="ArrowIpcDictionaryEncoding::kind__ArrowIpcDictionaryKind"></span><span
class="target"
id="struct_arrow_ipc_dictionary_encoding_1a128abe6dd3902b91035edc6af9d0336d"></span><span
class="k"><span class="pre">enum</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv422ArrowIpcDictionaryKind"
title="ArrowIpcDictionaryKind"><span class="n"> [...]
+<dd><p>The dictionary kind. </p>
+<p>Currently only one dictionary kind is permitted by the Arrow specification
(DenseArray). </p>
+</dd></dl>
+
+</div>
+</dd></dl>
+
+<dl class="cpp struct">
+<dt class="sig sig-object cpp" id="_CPPv427ArrowIpcDictionaryEncodings">
+<span id="_CPPv327ArrowIpcDictionaryEncodings"></span><span
id="_CPPv227ArrowIpcDictionaryEncodings"></span><span
id="ArrowIpcDictionaryEncodings"></span><span class="target"
id="struct_arrow_ipc_dictionary_encodings"></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">ArrowIpcDictionaryEncodings</span></span></span><a
class="headerlink" href="#_CPPv427ArrowIpcDictionaryEncodings" title="Li [...]
+<dd><div class="docutils container">
+<em>#include <nanoarrow_ipc.h></em></div>
+<p>List of <a class="reference internal"
href="#struct_arrow_ipc_dictionary_encoding"><span class="std
std-ref">ArrowIpcDictionaryEncoding</span></a> structs. </p>
+<p>This structure provides a list of dictionary encoded fields extracted from
an <a class="reference internal" href="c.html#struct_arrow_schema"><span
class="std std-ref">ArrowSchema</span></a> during decoding. Its members refer
to pointers within a specific schema, so care must be taken to keep the schema
containing the pointed-to <a class="reference internal"
href="c.html#struct_arrow_schema"><span class="std
std-ref">ArrowSchema</span></a> fields valid. </p>
+</dd></dl>
+
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv420ArrowIpcSharedBuffer">
<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="Link to this definition">#</a><br
/></dt>
@@ -1121,6 +1221,12 @@
<dd><p>Class wrapping a unique struct ArrowIpcFooter. </p>
</dd></dl>
+<dl class="cpp type">
+<dt class="sig sig-object cpp" id="_CPPv425UniqueDictionaryEncodings">
+<span id="_CPPv325UniqueDictionaryEncodings"></span><span
id="_CPPv225UniqueDictionaryEncodings"></span><span class="target"
id="group__nanoarrow__ipc__hpp-unique_1ga89c18f00d6e78e3d71a9bebd8bfe208c"></span><span
class="k"><span class="pre">using</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">UniqueDictionaryEncodings</span></span></span><span class="w">
</span><span class="p"><span class="pre">=</span></span><span class="w"> </span
[...]
+<dd><p>Class wrapping a unique struct <a class="reference internal"
href="#struct_arrow_ipc_dictionary_encodings"><span class="std
std-ref">ArrowIpcDictionaryEncodings</span></a>. </p>
+</dd></dl>
+
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv413UniqueEncoder">
<span id="_CPPv313UniqueEncoder"></span><span
id="_CPPv213UniqueEncoder"></span><span class="target"
id="group__nanoarrow__ipc__hpp-unique_1ga7d8001dff97da64dce4f8a13521bbaa5"></span><span
class="k"><span class="pre">using</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">UniqueEncoder</span></span></span><span class="w"> </span><span
class="p"><span class="pre">=</span></span><span class="w"> </span><span
class="n"><span class="pre">i [...]
@@ -1237,6 +1343,11 @@
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N23ArrowIpcCompressionType35NANOARROW_IPC_COMPRESSION_TYPE_ZSTDE"><code
class="docutils literal notranslate"><span
class="pre">NANOARROW_IPC_COMPRESSION_TYPE_ZSTD</span></code></a></li>
</ul>
</li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv422ArrowIpcDictionaryKind"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcDictionaryKind</span></code></a><ul
class="nav section-nav flex-column">
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N22ArrowIpcDictionaryKind43NANOARROW_IPC_DICTIONARY_KIND_UNINITIALIZEDE"><code
class="docutils literal notranslate"><span
class="pre">NANOARROW_IPC_DICTIONARY_KIND_UNINITIALIZED</span></code></a></li>
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N22ArrowIpcDictionaryKind41NANOARROW_IPC_DICTIONARY_KIND_DENSE_ARRAYE"><code
class="docutils literal notranslate"><span
class="pre">NANOARROW_IPC_DICTIONARY_KIND_DENSE_ARRAY</span></code></a></li>
+</ul>
+</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv424ArrowIpcSystemEndiannessv"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcSystemEndianness()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv423ArrowIpcWriterStartFileP14ArrowIpcWriterP10ArrowError"><code
class="docutils literal notranslate"><span
class="pre">ArrowIpcWriterStartFile()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv423ArrowIpcDictionaryBatch"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcDictionaryBatch</span></code></a><ul
class="nav section-nav flex-column">
@@ -1244,6 +1355,13 @@
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N23ArrowIpcDictionaryBatch8is_deltaE"><code class="docutils
literal notranslate"><span class="pre">is_delta</span></code></a></li>
</ul>
</li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv426ArrowIpcDictionaryEncoding"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcDictionaryEncoding</span></code></a><ul
class="nav section-nav flex-column">
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N26ArrowIpcDictionaryEncoding6schemaE"><code class="docutils
literal notranslate"><span class="pre">schema</span></code></a></li>
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N26ArrowIpcDictionaryEncoding2idE"><code class="docutils literal
notranslate"><span class="pre">id</span></code></a></li>
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N26ArrowIpcDictionaryEncoding4kindE"><code class="docutils literal
notranslate"><span class="pre">kind</span></code></a></li>
+</ul>
+</li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv427ArrowIpcDictionaryEncodings"><code class="docutils literal
notranslate"><span
class="pre">ArrowIpcDictionaryEncodings</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv420ArrowIpcSharedBuffer"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcSharedBuffer</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv420ArrowIpcDecompressor"><code class="docutils literal
notranslate"><span class="pre">ArrowIpcDecompressor</span></code></a><ul
class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv4N20ArrowIpcDecompressor14decompress_addE"><code class="docutils
literal notranslate"><span class="pre">decompress_add</span></code></a></li>
@@ -1296,6 +1414,7 @@
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv418UniqueSharedBuffer"><code class="docutils literal
notranslate"><span class="pre">UniqueSharedBuffer</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv413UniqueDecoder"><code class="docutils literal notranslate"><span
class="pre">UniqueDecoder</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv412UniqueFooter"><code class="docutils literal notranslate"><span
class="pre">UniqueFooter</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv425UniqueDictionaryEncodings"><code class="docutils literal
notranslate"><span class="pre">UniqueDictionaryEncodings</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv413UniqueEncoder"><code class="docutils literal notranslate"><span
class="pre">UniqueEncoder</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv418UniqueDecompressor"><code class="docutils literal
notranslate"><span class="pre">UniqueDecompressor</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#_CPPv417UniqueInputStream"><code class="docutils literal
notranslate"><span class="pre">UniqueInputStream</span></code></a></li>
diff --git a/main/searchindex.js b/main/searchindex.js
index 911ccf94..0101f584 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
