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 2a354d3 update documentation for tag dev
2a354d3 is described below
commit 2a354d37f68808c6b3db69b16e67d564e8f3e911
Author: GitHub Actions <[email protected]>
AuthorDate: Tue Oct 25 18:57:10 2022 +0000
update documentation for tag dev
---
dev/c.html | 298 ++++++++++++++++++++-----
dev/cpp.html | 79 +++++--
dev/genindex.html | 89 +++++++-
dev/objects.inv | Bin 10166 -> 11400 bytes
dev/r/pkgdown.yml | 2 +-
dev/r/reference/as_nanoarrow_array.html | 4 +-
dev/r/reference/as_nanoarrow_array_stream.html | 2 +-
dev/r/reference/nanoarrow_build_id.html | 2 +-
dev/r/search.json | 2 +-
dev/searchindex.js | 2 +-
10 files changed, 390 insertions(+), 90 deletions(-)
diff --git a/dev/c.html b/dev/c.html
index 453e1a7..a2a011a 100644
--- a/dev/c.html
+++ b/dev/c.html
@@ -284,82 +284,82 @@
<dl>
<dt class="sig sig-object cpp">
<span class="target" id="group__nanoarrow-schema"></span><em><span
class="pre">group</span></em> <span class="sig-name descname"><span
class="pre">nanoarrow-schema</span></span></dt>
-<dd><p>These functions allocate, copy, and destroy ArrowSchema structures. </p>
+<dd><p>These functions allocate, copy, and destroy <a class="reference
internal" href="#struct_arrow_schema"><span class="std
std-ref">ArrowSchema</span></a> structures. </p>
<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"
id="_CPPv415ArrowSchemaInitP11ArrowSchema9ArrowType">
-<span id="_CPPv315ArrowSchemaInitP11ArrowSchema9ArrowType"></span><span
id="_CPPv215ArrowSchemaInitP11ArrowSchema9ArrowType"></span><span
id="ArrowSchemaInit__ArrowSchemaP.ArrowType"></span><span class="target"
id="group__nanoarrow-schema_1ga0b6cd215e9ca7b1a4f88441d976774dc"></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="sig-name descname"><sp [...]
+<span id="_CPPv315ArrowSchemaInitP11ArrowSchema9ArrowType"></span><span
id="_CPPv215ArrowSchemaInitP11ArrowSchema9ArrowType"></span><span
id="ArrowSchemaInit__ArrowSchemaP.ArrowType"></span><span class="target"
id="group__nanoarrow-schema_1ga0b6cd215e9ca7b1a4f88441d976774dc"></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="sig-name descname"><sp [...]
<dd><p>Initialize the fields of a schema. </p>
<p>Initializes the fields and release callback of schema_out. Caller is
responsible for calling the schema->release callback if NANOARROW_OK is
returned. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv419ArrowSchemaToStringP11ArrowSchemaPc7int64_tc">
-<span id="_CPPv319ArrowSchemaToStringP11ArrowSchemaPc7int64_tc"></span><span
id="_CPPv219ArrowSchemaToStringP11ArrowSchemaPc7int64_tc"></span><span
id="ArrowSchemaToString__ArrowSchemaP.cP.int64_t.c"></span><span class="target"
id="group__nanoarrow-schema_1gac04b2acd1d7522377c4d2ea722e8ccf8"></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">ArrowSchemaToString</span></span></span><span c [...]
+<span id="_CPPv319ArrowSchemaToStringP11ArrowSchemaPc7int64_tc"></span><span
id="_CPPv219ArrowSchemaToStringP11ArrowSchemaPc7int64_tc"></span><span
id="ArrowSchemaToString__ArrowSchemaP.cP.int64_t.c"></span><span class="target"
id="group__nanoarrow-schema_1gac04b2acd1d7522377c4d2ea722e8ccf8"></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">ArrowSchemaToString</span></span></span><span c [...]
<dd><p>Get a human-readable summary of a Schema. </p>
-<p>Writes a summary of an ArrowSchema to out (up to n - 1 characters) and
returns the number of characters required for the output if n were sufficiently
large. If recursive is non-zero, the result will also include children. </p>
+<p>Writes a summary of an <a class="reference internal"
href="#struct_arrow_schema"><span class="std std-ref">ArrowSchema</span></a> to
out (up to n - 1 characters) and returns the number of characters required for
the output if n were sufficiently large. If recursive is non-zero, the result
will also include children. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv424ArrowSchemaInitFixedSizeP11ArrowSchema9ArrowType7int32_t">
-<span
id="_CPPv324ArrowSchemaInitFixedSizeP11ArrowSchema9ArrowType7int32_t"></span><span
id="_CPPv224ArrowSchemaInitFixedSizeP11ArrowSchema9ArrowType7int32_t"></span><span
id="ArrowSchemaInitFixedSize__ArrowSchemaP.ArrowType.int32_t"></span><span
class="target"
id="group__nanoarrow-schema_1gaae42dfd2a0647fa115f8c6bf55e6a901"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span cl [...]
+<span
id="_CPPv324ArrowSchemaInitFixedSizeP11ArrowSchema9ArrowType7int32_t"></span><span
id="_CPPv224ArrowSchemaInitFixedSizeP11ArrowSchema9ArrowType7int32_t"></span><span
id="ArrowSchemaInitFixedSize__ArrowSchemaP.ArrowType.int32_t"></span><span
class="target"
id="group__nanoarrow-schema_1gaae42dfd2a0647fa115f8c6bf55e6a901"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span cl [...]
<dd><p>Initialize the fields of a fixed-size schema. </p>
<p>Returns EINVAL for fixed_size <= 0 or for data_type that is not
NANOARROW_TYPE_FIXED_SIZE_BINARY or NANOARROW_TYPE_FIXED_SIZE_LIST. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv422ArrowSchemaInitDecimalP11ArrowSchema9ArrowType7int32_t7int32_t">
-<span
id="_CPPv322ArrowSchemaInitDecimalP11ArrowSchema9ArrowType7int32_t7int32_t"></span><span
id="_CPPv222ArrowSchemaInitDecimalP11ArrowSchema9ArrowType7int32_t7int32_t"></span><span
id="ArrowSchemaInitDecimal__ArrowSchemaP.ArrowType.int32_t.int32_t"></span><span
class="target"
id="group__nanoarrow-schema_1ga33ecf70ad7b6e651f803724297d07f4f"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span class="pre">ArrowErrorCode</span><
[...]
+<span
id="_CPPv322ArrowSchemaInitDecimalP11ArrowSchema9ArrowType7int32_t7int32_t"></span><span
id="_CPPv222ArrowSchemaInitDecimalP11ArrowSchema9ArrowType7int32_t7int32_t"></span><span
id="ArrowSchemaInitDecimal__ArrowSchemaP.ArrowType.int32_t.int32_t"></span><span
class="target"
id="group__nanoarrow-schema_1ga33ecf70ad7b6e651f803724297d07f4f"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span class="pre">ArrowErrorCode</span><
[...]
<dd><p>Initialize the fields of a decimal schema. </p>
<p>Returns EINVAL for scale <= 0 or for data_type that is not
NANOARROW_TYPE_DECIMAL128 or NANOARROW_TYPE_DECIMAL256. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv423ArrowSchemaInitDateTimeP11ArrowSchema9ArrowType13ArrowTimeUnitPKc">
-<span
id="_CPPv323ArrowSchemaInitDateTimeP11ArrowSchema9ArrowType13ArrowTimeUnitPKc"></span><span
id="_CPPv223ArrowSchemaInitDateTimeP11ArrowSchema9ArrowType13ArrowTimeUnitPKc"></span><span
id="ArrowSchemaInitDateTime__ArrowSchemaP.ArrowType.ArrowTimeUnit.cCP"></span><span
class="target"
id="group__nanoarrow-schema_1gad43b01bf88395fbeac17fe8424d05fe8"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span class="pre">ArrowErrorCod [...]
+<span
id="_CPPv323ArrowSchemaInitDateTimeP11ArrowSchema9ArrowType13ArrowTimeUnitPKc"></span><span
id="_CPPv223ArrowSchemaInitDateTimeP11ArrowSchema9ArrowType13ArrowTimeUnitPKc"></span><span
id="ArrowSchemaInitDateTime__ArrowSchemaP.ArrowType.ArrowTimeUnit.cCP"></span><span
class="target"
id="group__nanoarrow-schema_1gad43b01bf88395fbeac17fe8424d05fe8"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span class="pre">ArrowErrorCod [...]
<dd><p>Initialize the fields of a time, timestamp, or duration schema. </p>
<p>Returns EINVAL for data_type that is not NANOARROW_TYPE_TIME32,
NANOARROW_TYPE_TIME64, NANOARROW_TYPE_TIMESTAMP, or NANOARROW_TYPE_DURATION.
The timezone parameter must be NULL for a non-timestamp data_type. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv419ArrowSchemaDeepCopyP11ArrowSchemaP11ArrowSchema">
-<span
id="_CPPv319ArrowSchemaDeepCopyP11ArrowSchemaP11ArrowSchema"></span><span
id="_CPPv219ArrowSchemaDeepCopyP11ArrowSchemaP11ArrowSchema"></span><span
id="ArrowSchemaDeepCopy__ArrowSchemaP.ArrowSchemaP"></span><span class="target"
id="group__nanoarrow-schema_1gaa6c710253f812d5d5f3663c204468af4"></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= [...]
+<span
id="_CPPv319ArrowSchemaDeepCopyP11ArrowSchemaP11ArrowSchema"></span><span
id="_CPPv219ArrowSchemaDeepCopyP11ArrowSchemaP11ArrowSchema"></span><span
id="ArrowSchemaDeepCopy__ArrowSchemaP.ArrowSchemaP"></span><span class="target"
id="group__nanoarrow-schema_1gaa6c710253f812d5d5f3663c204468af4"></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= [...]
<dd><p>Make a (recursive) copy of a schema. </p>
<p>Allocates and copies fields of schema into schema_out. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv420ArrowSchemaSetFormatP11ArrowSchemaPKc">
-<span id="_CPPv320ArrowSchemaSetFormatP11ArrowSchemaPKc"></span><span
id="_CPPv220ArrowSchemaSetFormatP11ArrowSchemaPKc"></span><span
id="ArrowSchemaSetFormat__ArrowSchemaP.cCP"></span><span class="target"
id="group__nanoarrow-schema_1ga8eb8a8a73a189ea2f9eabdc237adbf84"></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="sig-name descname"><span cl [...]
+<span id="_CPPv320ArrowSchemaSetFormatP11ArrowSchemaPKc"></span><span
id="_CPPv220ArrowSchemaSetFormatP11ArrowSchemaPKc"></span><span
id="ArrowSchemaSetFormat__ArrowSchemaP.cCP"></span><span class="target"
id="group__nanoarrow-schema_1ga8eb8a8a73a189ea2f9eabdc237adbf84"></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="sig-name descname"><span cl [...]
<dd><p>Copy format into schema->format. </p>
<p>schema must have been allocated using <a class="reference internal"
href="#group__nanoarrow-schema_1ga0b6cd215e9ca7b1a4f88441d976774dc"><span
class="std std-ref">ArrowSchemaInit()</span></a> or <a class="reference
internal"
href="#group__nanoarrow-schema_1gaa6c710253f812d5d5f3663c204468af4"><span
class="std std-ref">ArrowSchemaDeepCopy()</span></a>. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv418ArrowSchemaSetNameP11ArrowSchemaPKc">
-<span id="_CPPv318ArrowSchemaSetNameP11ArrowSchemaPKc"></span><span
id="_CPPv218ArrowSchemaSetNameP11ArrowSchemaPKc"></span><span
id="ArrowSchemaSetName__ArrowSchemaP.cCP"></span><span class="target"
id="group__nanoarrow-schema_1ga8724121ffb964a258577e1fb6038a2ab"></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="sig-name descname"><span class="n [...]
+<span id="_CPPv318ArrowSchemaSetNameP11ArrowSchemaPKc"></span><span
id="_CPPv218ArrowSchemaSetNameP11ArrowSchemaPKc"></span><span
id="ArrowSchemaSetName__ArrowSchemaP.cCP"></span><span class="target"
id="group__nanoarrow-schema_1ga8724121ffb964a258577e1fb6038a2ab"></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="sig-name descname"><span class="n [...]
<dd><p>Copy name into schema->name. </p>
<p>schema must have been allocated using <a class="reference internal"
href="#group__nanoarrow-schema_1ga0b6cd215e9ca7b1a4f88441d976774dc"><span
class="std std-ref">ArrowSchemaInit()</span></a> or <a class="reference
internal"
href="#group__nanoarrow-schema_1gaa6c710253f812d5d5f3663c204468af4"><span
class="std std-ref">ArrowSchemaDeepCopy()</span></a>. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv422ArrowSchemaSetMetadataP11ArrowSchemaPKc">
-<span id="_CPPv322ArrowSchemaSetMetadataP11ArrowSchemaPKc"></span><span
id="_CPPv222ArrowSchemaSetMetadataP11ArrowSchemaPKc"></span><span
id="ArrowSchemaSetMetadata__ArrowSchemaP.cCP"></span><span class="target"
id="group__nanoarrow-schema_1ga3755dcc5bdbc9c850a5576ea74713c2b"></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="sig-name descname"><s [...]
+<span id="_CPPv322ArrowSchemaSetMetadataP11ArrowSchemaPKc"></span><span
id="_CPPv222ArrowSchemaSetMetadataP11ArrowSchemaPKc"></span><span
id="ArrowSchemaSetMetadata__ArrowSchemaP.cCP"></span><span class="target"
id="group__nanoarrow-schema_1ga3755dcc5bdbc9c850a5576ea74713c2b"></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="sig-name descname"><s [...]
<dd><p>Copy metadata into schema->metadata. </p>
<p>schema must have been allocated using <a class="reference internal"
href="#group__nanoarrow-schema_1ga0b6cd215e9ca7b1a4f88441d976774dc"><span
class="std std-ref">ArrowSchemaInit()</span></a> or ArrowSchemaDeepCopy. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv427ArrowSchemaAllocateChildrenP11ArrowSchema7int64_t">
-<span
id="_CPPv327ArrowSchemaAllocateChildrenP11ArrowSchema7int64_t"></span><span
id="_CPPv227ArrowSchemaAllocateChildrenP11ArrowSchema7int64_t"></span><span
id="ArrowSchemaAllocateChildren__ArrowSchemaP.int64_t"></span><span
class="target"
id="group__nanoarrow-schema_1gabdbe36e6bdca89a4a8c3e11c6bb4660e"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span class="w"> </span><span [...]
+<span
id="_CPPv327ArrowSchemaAllocateChildrenP11ArrowSchema7int64_t"></span><span
id="_CPPv227ArrowSchemaAllocateChildrenP11ArrowSchema7int64_t"></span><span
id="ArrowSchemaAllocateChildren__ArrowSchemaP.int64_t"></span><span
class="target"
id="group__nanoarrow-schema_1gabdbe36e6bdca89a4a8c3e11c6bb4660e"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span class="w"> </span><span [...]
<dd><p>Allocate the schema->children array. </p>
-<p>Includes the memory for each child struct ArrowSchema. schema must have
been allocated using <a class="reference internal"
href="#group__nanoarrow-schema_1ga0b6cd215e9ca7b1a4f88441d976774dc"><span
class="std std-ref">ArrowSchemaInit()</span></a> or <a class="reference
internal"
href="#group__nanoarrow-schema_1gaa6c710253f812d5d5f3663c204468af4"><span
class="std std-ref">ArrowSchemaDeepCopy()</span></a>. </p>
+<p>Includes the memory for each child struct <a class="reference internal"
href="#struct_arrow_schema"><span class="std std-ref">ArrowSchema</span></a>.
schema must have been allocated using <a class="reference internal"
href="#group__nanoarrow-schema_1ga0b6cd215e9ca7b1a4f88441d976774dc"><span
class="std std-ref">ArrowSchemaInit()</span></a> or <a class="reference
internal"
href="#group__nanoarrow-schema_1gaa6c710253f812d5d5f3663c204468af4"><span
class="std std-ref">ArrowSchemaDeepCopy() [...]
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv429ArrowSchemaAllocateDictionaryP11ArrowSchema">
-<span id="_CPPv329ArrowSchemaAllocateDictionaryP11ArrowSchema"></span><span
id="_CPPv229ArrowSchemaAllocateDictionaryP11ArrowSchema"></span><span
id="ArrowSchemaAllocateDictionary__ArrowSchemaP"></span><span class="target"
id="group__nanoarrow-schema_1ga7c2cc4b5fec3950a9d6cebda6af279da"></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="sig-name d [...]
+<span id="_CPPv329ArrowSchemaAllocateDictionaryP11ArrowSchema"></span><span
id="_CPPv229ArrowSchemaAllocateDictionaryP11ArrowSchema"></span><span
id="ArrowSchemaAllocateDictionary__ArrowSchemaP"></span><span class="target"
id="group__nanoarrow-schema_1ga7c2cc4b5fec3950a9d6cebda6af279da"></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="sig-name d [...]
<dd><p>Allocate the schema->dictionary member. </p>
<p>schema must have been allocated using <a class="reference internal"
href="#group__nanoarrow-schema_1ga0b6cd215e9ca7b1a4f88441d976774dc"><span
class="std std-ref">ArrowSchemaInit()</span></a> or <a class="reference
internal"
href="#group__nanoarrow-schema_1gaa6c710253f812d5d5f3663c204468af4"><span
class="std std-ref">ArrowSchemaDeepCopy()</span></a>. </p>
</dd></dl>
@@ -377,7 +377,7 @@
<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-functions">Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv419ArrowSchemaViewInitP15ArrowSchemaViewP11ArrowSchemaP10ArrowError">
-<span
id="_CPPv319ArrowSchemaViewInitP15ArrowSchemaViewP11ArrowSchemaP10ArrowError"></span><span
id="_CPPv219ArrowSchemaViewInitP15ArrowSchemaViewP11ArrowSchemaP10ArrowError"></span><span
id="ArrowSchemaViewInit__ArrowSchemaViewP.ArrowSchemaP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow-schema-view_1ga3e14b8d831ace92286c476206ba00ca1"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span class="pre">ArrowErrorCod [...]
+<span
id="_CPPv319ArrowSchemaViewInitP15ArrowSchemaViewP11ArrowSchemaP10ArrowError"></span><span
id="_CPPv219ArrowSchemaViewInitP15ArrowSchemaViewP11ArrowSchemaP10ArrowError"></span><span
id="ArrowSchemaViewInit__ArrowSchemaViewP.ArrowSchemaP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow-schema-view_1ga3e14b8d831ace92286c476206ba00ca1"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span class="pre">ArrowErrorCod [...]
<dd><p>Initialize an <a class="reference internal"
href="#struct_arrow_schema_view"><span class="std
std-ref">ArrowSchemaView</span></a>. </p>
</dd></dl>
@@ -387,13 +387,13 @@
<span id="_CPPv315ArrowSchemaView"></span><span
id="_CPPv215ArrowSchemaView"></span><span id="ArrowSchemaView"></span><span
class="target" id="struct_arrow_schema_view"></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">ArrowSchemaView</span></span></span><a class="headerlink"
href="#_CPPv415ArrowSchemaView" title="Permalink to this definition">#</a><br
/></dt>
<dd><div class="docutils container">
<em>#include <nanoarrow.h></em></div>
-<p>A non-owning view of a parsed ArrowSchema. </p>
-<p>Contains more readily extractable values than a raw ArrowSchema. Clients
can stack or statically allocate this structure but are encouraged to use the
provided getters to ensure forward compatiblity. </p>
+<p>A non-owning view of a parsed <a class="reference internal"
href="#struct_arrow_schema"><span class="std std-ref">ArrowSchema</span></a>.
</p>
+<p>Contains more readily extractable values than a raw <a class="reference
internal" href="#struct_arrow_schema"><span class="std
std-ref">ArrowSchema</span></a>. Clients can stack or statically allocate this
structure but are encouraged to use the provided getters to ensure forward
compatiblity. </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="_CPPv4N15ArrowSchemaView6schemaE">
-<span id="_CPPv3N15ArrowSchemaView6schemaE"></span><span
id="_CPPv2N15ArrowSchemaView6schemaE"></span><span
id="ArrowSchemaView::schema__ArrowSchemaP"></span><span class="target"
id="struct_arrow_schema_view_1a57cab09d0c332eaf55d4886d600ecd6a"></span><span
class="k"><span class="pre">struct</span></span><span class="w"> </span><span
class="n"><span class="pre">ArrowSchema</span></span><span class="w">
</span><span class="p"><span class="pre">*</span></span><span class="sig-name
descname" [...]
+<span id="_CPPv3N15ArrowSchemaView6schemaE"></span><span
id="_CPPv2N15ArrowSchemaView6schemaE"></span><span
id="ArrowSchemaView::schema__ArrowSchemaP"></span><span class="target"
id="struct_arrow_schema_view_1a57cab09d0c332eaf55d4886d600ecd6a"></span><span
class="k"><span class="pre">struct</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv411ArrowSchema"
title="ArrowSchema"><span class="n"><span
class="pre">ArrowSchema</span></span></a><span class="w"> </spa [...]
<dd><p>A pointer to the schema represented by this view. </p>
</dd></dl>
@@ -491,137 +491,137 @@
<dl>
<dt class="sig sig-object cpp">
<span class="target" id="group__nanoarrow-array"></span><em><span
class="pre">group</span></em> <span class="sig-name descname"><span
class="pre">nanoarrow-array</span></span></dt>
-<dd><p>These functions allocate, copy, and destroy ArrowArray structures. </p>
+<dd><p>These functions allocate, copy, and destroy <a class="reference
internal" href="#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a> structures. </p>
<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"
id="_CPPv414ArrowArrayInitP10ArrowArray9ArrowType">
-<span id="_CPPv314ArrowArrayInitP10ArrowArray9ArrowType"></span><span
id="_CPPv214ArrowArrayInitP10ArrowArray9ArrowType"></span><span
id="ArrowArrayInit__ArrowArrayP.ArrowType"></span><span class="target"
id="group__nanoarrow-array_1ga2c80b8404ed26bba84ba1a436c2ac26c"></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="sig-name descname"><span clas [...]
+<span id="_CPPv314ArrowArrayInitP10ArrowArray9ArrowType"></span><span
id="_CPPv214ArrowArrayInitP10ArrowArray9ArrowType"></span><span
id="ArrowArrayInit__ArrowArrayP.ArrowType"></span><span class="target"
id="group__nanoarrow-array_1ga2c80b8404ed26bba84ba1a436c2ac26c"></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="sig-name descname"><span clas [...]
<dd><p>Initialize the fields of an array. </p>
<p>Initializes the fields and release callback of array. 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="_CPPv424ArrowArrayInitFromSchemaP10ArrowArrayP11ArrowSchemaP10ArrowError">
-<span
id="_CPPv324ArrowArrayInitFromSchemaP10ArrowArrayP11ArrowSchemaP10ArrowError"></span><span
id="_CPPv224ArrowArrayInitFromSchemaP10ArrowArrayP11ArrowSchemaP10ArrowError"></span><span
id="ArrowArrayInitFromSchema__ArrowArrayP.ArrowSchemaP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow-array_1ga31a82c7fe72e5cc46eeab4713c284f84"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span class="pre">ArrowErrorCode</spa
[...]
-<dd><p>Initialize the contents of an ArrowArray from an ArrowSchema. </p>
+<span
id="_CPPv324ArrowArrayInitFromSchemaP10ArrowArrayP11ArrowSchemaP10ArrowError"></span><span
id="_CPPv224ArrowArrayInitFromSchemaP10ArrowArrayP11ArrowSchemaP10ArrowError"></span><span
id="ArrowArrayInitFromSchema__ArrowArrayP.ArrowSchemaP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow-array_1ga31a82c7fe72e5cc46eeab4713c284f84"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span class="pre">ArrowErrorCode</spa
[...]
+<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_schema"><span class="std
std-ref">ArrowSchema</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= [...]
+<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= [...]
<dd><p>Allocate the array->children array. </p>
-<p>Includes the memory for each child struct ArrowArray, whose members are
marked as released and may be subsequently initialized with <a class="reference
internal"
href="#group__nanoarrow-array_1ga2c80b8404ed26bba84ba1a436c2ac26c"><span
class="std std-ref">ArrowArrayInit()</span></a> or moved from an existing
ArrowArray. schema must have been allocated using <a class="reference internal"
href="#group__nanoarrow-array_1ga2c80b8404ed26bba84ba1a436c2ac26c"><span
class="std std-ref">ArrowAr [...]
+<p>Includes the memory for each child struct <a class="reference internal"
href="#struct_arrow_array"><span class="std std-ref">ArrowArray</span></a>,
whose members are marked as released and may be subsequently initialized with
<a class="reference internal"
href="#group__nanoarrow-array_1ga2c80b8404ed26bba84ba1a436c2ac26c"><span
class="std std-ref">ArrowArrayInit()</span></a> or moved from an existing <a
class="reference internal" href="#struct_arrow_array"><span class="std
std-ref">Arr [...]
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv428ArrowArrayAllocateDictionaryP10ArrowArray">
-<span id="_CPPv328ArrowArrayAllocateDictionaryP10ArrowArray"></span><span
id="_CPPv228ArrowArrayAllocateDictionaryP10ArrowArray"></span><span
id="ArrowArrayAllocateDictionary__ArrowArrayP"></span><span class="target"
id="group__nanoarrow-array_1ga0bfe9d4cddb8de65e29ab46ce0b495a4"></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="sig-name descname [...]
+<span id="_CPPv328ArrowArrayAllocateDictionaryP10ArrowArray"></span><span
id="_CPPv228ArrowArrayAllocateDictionaryP10ArrowArray"></span><span
id="ArrowArrayAllocateDictionary__ArrowArrayP"></span><span class="target"
id="group__nanoarrow-array_1ga0bfe9d4cddb8de65e29ab46ce0b495a4"></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="sig-name descname [...]
<dd><p>Allocate the array->dictionary member. </p>
-<p>Includes the memory for the struct ArrowArray, whose contents is marked as
released and may be subsequently initialized with <a class="reference internal"
href="#group__nanoarrow-array_1ga2c80b8404ed26bba84ba1a436c2ac26c"><span
class="std std-ref">ArrowArrayInit()</span></a> or moved from an existing
ArrowArray. array must have been allocated using <a class="reference internal"
href="#group__nanoarrow-array_1ga2c80b8404ed26bba84ba1a436c2ac26c"><span
class="std std-ref">ArrowArrayInit( [...]
+<p>Includes the memory for the struct <a class="reference internal"
href="#struct_arrow_array"><span class="std std-ref">ArrowArray</span></a>,
whose contents is marked as released and may be subsequently initialized with
<a class="reference internal"
href="#group__nanoarrow-array_1ga2c80b8404ed26bba84ba1a436c2ac26c"><span
class="std std-ref">ArrowArrayInit()</span></a> or moved from an existing <a
class="reference internal" href="#struct_arrow_array"><span class="std
std-ref">ArrowArray [...]
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv427ArrowArraySetValidityBitmapP10ArrowArrayP11ArrowBitmap">
-<span
id="_CPPv327ArrowArraySetValidityBitmapP10ArrowArrayP11ArrowBitmap"></span><span
id="_CPPv227ArrowArraySetValidityBitmapP10ArrowArrayP11ArrowBitmap"></span><span
id="ArrowArraySetValidityBitmap__ArrowArrayP.ArrowBitmapP"></span><span
class="target"
id="group__nanoarrow-array_1gad8aef62893226fa4764a9c63eb602080"></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">ArrowArraySetValidityBi [...]
-<dd><p>Set the validity bitmap of an ArrowArray. </p>
+<span
id="_CPPv327ArrowArraySetValidityBitmapP10ArrowArrayP11ArrowBitmap"></span><span
id="_CPPv227ArrowArraySetValidityBitmapP10ArrowArrayP11ArrowBitmap"></span><span
id="ArrowArraySetValidityBitmap__ArrowArrayP.ArrowBitmapP"></span><span
class="target"
id="group__nanoarrow-array_1gad8aef62893226fa4764a9c63eb602080"></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">ArrowArraySetValidityBi [...]
+<dd><p>Set the validity bitmap of an <a class="reference internal"
href="#struct_arrow_array"><span class="std std-ref">ArrowArray</span></a>. </p>
<p>array must have been allocated using <a class="reference internal"
href="#group__nanoarrow-array_1ga2c80b8404ed26bba84ba1a436c2ac26c"><span
class="std std-ref">ArrowArrayInit()</span></a> </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv419ArrowArraySetBufferP10ArrowArray7int64_tP11ArrowBuffer">
-<span
id="_CPPv319ArrowArraySetBufferP10ArrowArray7int64_tP11ArrowBuffer"></span><span
id="_CPPv219ArrowArraySetBufferP10ArrowArray7int64_tP11ArrowBuffer"></span><span
id="ArrowArraySetBuffer__ArrowArrayP.int64_t.ArrowBufferP"></span><span
class="target"
id="group__nanoarrow-array_1ga52111316e373e24687710f5158da3527"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span class="w"> [...]
-<dd><p>Set a buffer of an ArrowArray. </p>
+<span
id="_CPPv319ArrowArraySetBufferP10ArrowArray7int64_tP11ArrowBuffer"></span><span
id="_CPPv219ArrowArraySetBufferP10ArrowArray7int64_tP11ArrowBuffer"></span><span
id="ArrowArraySetBuffer__ArrowArrayP.int64_t.ArrowBufferP"></span><span
class="target"
id="group__nanoarrow-array_1ga52111316e373e24687710f5158da3527"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span class="w"> [...]
+<dd><p>Set a buffer of an <a class="reference internal"
href="#struct_arrow_array"><span class="std std-ref">ArrowArray</span></a>. </p>
<p>array must have been allocated using <a class="reference internal"
href="#group__nanoarrow-array_1ga2c80b8404ed26bba84ba1a436c2ac26c"><span
class="std std-ref">ArrowArrayInit()</span></a> </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv424ArrowArrayValidityBitmapP10ArrowArray">
-<span id="_CPPv324ArrowArrayValidityBitmapP10ArrowArray"></span><span
id="_CPPv224ArrowArrayValidityBitmapP10ArrowArray"></span><span
id="ArrowArrayValidityBitmap__ArrowArrayP"></span><span class="target"
id="group__nanoarrow-array_1ga3e0fdea696cd9afabd3eb2a59ea95375"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="k"><span class="pre">struct</span></span><span [...]
-<dd><p>Get the validity bitmap of an ArrowArray. </p>
+<span id="_CPPv324ArrowArrayValidityBitmapP10ArrowArray"></span><span
id="_CPPv224ArrowArrayValidityBitmapP10ArrowArray"></span><span
id="ArrowArrayValidityBitmap__ArrowArrayP"></span><span class="target"
id="group__nanoarrow-array_1ga3e0fdea696cd9afabd3eb2a59ea95375"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="k"><span class="pre">struct</span></span><span [...]
+<dd><p>Get the validity bitmap of an <a class="reference internal"
href="#struct_arrow_array"><span class="std std-ref">ArrowArray</span></a>. </p>
<p>array must have been allocated using <a class="reference internal"
href="#group__nanoarrow-array_1ga2c80b8404ed26bba84ba1a436c2ac26c"><span
class="std std-ref">ArrowArrayInit()</span></a> </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv416ArrowArrayBufferP10ArrowArray7int64_t">
-<span id="_CPPv316ArrowArrayBufferP10ArrowArray7int64_t"></span><span
id="_CPPv216ArrowArrayBufferP10ArrowArray7int64_t"></span><span
id="ArrowArrayBuffer__ArrowArrayP.int64_t"></span><span class="target"
id="group__nanoarrow-array_1gafbd17d94c188c9760f5bc91195683bd8"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="k"><span class="pre">struct</span></span><span [...]
-<dd><p>Get a buffer of an ArrowArray. </p>
+<span id="_CPPv316ArrowArrayBufferP10ArrowArray7int64_t"></span><span
id="_CPPv216ArrowArrayBufferP10ArrowArray7int64_t"></span><span
id="ArrowArrayBuffer__ArrowArrayP.int64_t"></span><span class="target"
id="group__nanoarrow-array_1gafbd17d94c188c9760f5bc91195683bd8"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="k"><span class="pre">struct</span></span><span [...]
+<dd><p>Get a buffer of an <a class="reference internal"
href="#struct_arrow_array"><span class="std std-ref">ArrowArray</span></a>. </p>
<p>array must have been allocated using <a class="reference internal"
href="#group__nanoarrow-array_1ga2c80b8404ed26bba84ba1a436c2ac26c"><span
class="std std-ref">ArrowArrayInit()</span></a> </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv424ArrowArrayStartAppendingP10ArrowArray">
-<span id="_CPPv324ArrowArrayStartAppendingP10ArrowArray"></span><span
id="_CPPv224ArrowArrayStartAppendingP10ArrowArray"></span><span
id="ArrowArrayStartAppending__ArrowArrayP"></span><span class="target"
id="group__nanoarrow-array_1gaab61ae0a0eb698c817bee25ee3a750f5"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv414ArrowErrorCode" [...]
-<dd><p>Start element-wise appending to an ArrowArray. </p>
+<span id="_CPPv324ArrowArrayStartAppendingP10ArrowArray"></span><span
id="_CPPv224ArrowArrayStartAppendingP10ArrowArray"></span><span
id="ArrowArrayStartAppending__ArrowArrayP"></span><span class="target"
id="group__nanoarrow-array_1gaab61ae0a0eb698c817bee25ee3a750f5"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv414ArrowErrorCode" [...]
+<dd><p>Start element-wise appending to an <a class="reference internal"
href="#struct_arrow_array"><span class="std std-ref">ArrowArray</span></a>. </p>
<p>Initializes any values needed to use ArrowArrayAppend*() functions. All
element-wise appenders append by value and return EINVAL if the exact value
cannot be represented by the underlying storage type. array must have been
allocated using <a class="reference internal"
href="#group__nanoarrow-array_1ga2c80b8404ed26bba84ba1a436c2ac26c"><span
class="std std-ref">ArrowArrayInit()</span></a> </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv417ArrowArrayReserveP10ArrowArray7int64_t">
-<span id="_CPPv317ArrowArrayReserveP10ArrowArray7int64_t"></span><span
id="_CPPv217ArrowArrayReserveP10ArrowArray7int64_t"></span><span
id="ArrowArrayReserve__ArrowArrayP.int64_t"></span><span class="target"
id="group__nanoarrow-array_1gaa2644de6315ff68a694370c51948071e"></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="sig-name descname"><span c [...]
+<span id="_CPPv317ArrowArrayReserveP10ArrowArray7int64_t"></span><span
id="_CPPv217ArrowArrayReserveP10ArrowArray7int64_t"></span><span
id="ArrowArrayReserve__ArrowArrayP.int64_t"></span><span class="target"
id="group__nanoarrow-array_1gaa2644de6315ff68a694370c51948071e"></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="sig-name descname"><span c [...]
<dd><p>Reserve space for future appends. </p>
<p>For buffer sizes that can be calculated (i.e., not string data buffers or
child array sizes for non-fixed-size arrays), recursively reserve space for
additional elements. This is useful for reducing the number of reallocations
that occur using the item-wise appenders. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv420ArrowArrayAppendNullP10ArrowArray7int64_t">
-<span id="_CPPv320ArrowArrayAppendNullP10ArrowArray7int64_t"></span><span
id="_CPPv220ArrowArrayAppendNullP10ArrowArray7int64_t"></span><span
id="ArrowArrayAppendNull__ArrowArrayP.int64_t"></span><span class="target"
id="group__nanoarrow-array_1ga7b4c3eb74f4bc6c6155599fb2658f927"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv414Arr [...]
+<span id="_CPPv320ArrowArrayAppendNullP10ArrowArray7int64_t"></span><span
id="_CPPv220ArrowArrayAppendNullP10ArrowArray7int64_t"></span><span
id="ArrowArrayAppendNull__ArrowArrayP.int64_t"></span><span class="target"
id="group__nanoarrow-array_1ga7b4c3eb74f4bc6c6155599fb2658f927"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv414Arr [...]
<dd><p>Append a null value to an array. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv419ArrowArrayAppendIntP10ArrowArray7int64_t">
-<span id="_CPPv319ArrowArrayAppendIntP10ArrowArray7int64_t"></span><span
id="_CPPv219ArrowArrayAppendIntP10ArrowArray7int64_t"></span><span
id="ArrowArrayAppendInt__ArrowArrayP.int64_t"></span><span class="target"
id="group__nanoarrow-array_1gac6b99a2b05db4c956def99131f803994"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv414ArrowE [...]
+<span id="_CPPv319ArrowArrayAppendIntP10ArrowArray7int64_t"></span><span
id="_CPPv219ArrowArrayAppendIntP10ArrowArray7int64_t"></span><span
id="ArrowArrayAppendInt__ArrowArrayP.int64_t"></span><span class="target"
id="group__nanoarrow-array_1gac6b99a2b05db4c956def99131f803994"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv414ArrowE [...]
<dd><p>Append a signed integer value to an array. </p>
<p>Returns NANOARROW_OK if value can be exactly represented by the underlying
storage type or EINVAL otherwise (e.g., value is outside the valid array
range). </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv420ArrowArrayAppendUIntP10ArrowArray8uint64_t">
-<span id="_CPPv320ArrowArrayAppendUIntP10ArrowArray8uint64_t"></span><span
id="_CPPv220ArrowArrayAppendUIntP10ArrowArray8uint64_t"></span><span
id="ArrowArrayAppendUInt__ArrowArrayP.uint64_t"></span><span class="target"
id="group__nanoarrow-array_1gae91f4c278859a8457b8090ca4dfd1e31"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv414 [...]
+<span id="_CPPv320ArrowArrayAppendUIntP10ArrowArray8uint64_t"></span><span
id="_CPPv220ArrowArrayAppendUIntP10ArrowArray8uint64_t"></span><span
id="ArrowArrayAppendUInt__ArrowArrayP.uint64_t"></span><span class="target"
id="group__nanoarrow-array_1gae91f4c278859a8457b8090ca4dfd1e31"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv414 [...]
<dd><p>Append an unsigned integer value to an array. </p>
<p>Returns NANOARROW_OK if value can be exactly represented by the underlying
storage type or EINVAL otherwise (e.g., value is outside the valid array
range). </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv422ArrowArrayAppendDoubleP10ArrowArrayd">
-<span id="_CPPv322ArrowArrayAppendDoubleP10ArrowArrayd"></span><span
id="_CPPv222ArrowArrayAppendDoubleP10ArrowArrayd"></span><span
id="ArrowArrayAppendDouble__ArrowArrayP.double"></span><span class="target"
id="group__nanoarrow-array_1ga2e03258b386ed299928471394586b185"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv414ArrowErrorCo [...]
+<span id="_CPPv322ArrowArrayAppendDoubleP10ArrowArrayd"></span><span
id="_CPPv222ArrowArrayAppendDoubleP10ArrowArrayd"></span><span
id="ArrowArrayAppendDouble__ArrowArrayP.double"></span><span class="target"
id="group__nanoarrow-array_1ga2e03258b386ed299928471394586b185"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv414ArrowErrorCo [...]
<dd><p>Append a double value to an array. </p>
<p>Returns NANOARROW_OK if value can be exactly represented by the underlying
storage type or EINVAL otherwise (e.g., value is outside the valid array range
or there is an attempt to append a non-integer to an array with an integer
storage type). </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv421ArrowArrayAppendBytesP10ArrowArray15ArrowBufferView">
-<span
id="_CPPv321ArrowArrayAppendBytesP10ArrowArray15ArrowBufferView"></span><span
id="_CPPv221ArrowArrayAppendBytesP10ArrowArray15ArrowBufferView"></span><span
id="ArrowArrayAppendBytes__ArrowArrayP.ArrowBufferView"></span><span
class="target"
id="group__nanoarrow-array_1ga40e1dce8b43124c9710538842e68f944"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference [...]
+<span
id="_CPPv321ArrowArrayAppendBytesP10ArrowArray15ArrowBufferView"></span><span
id="_CPPv221ArrowArrayAppendBytesP10ArrowArray15ArrowBufferView"></span><span
id="ArrowArrayAppendBytes__ArrowArrayP.ArrowBufferView"></span><span
class="target"
id="group__nanoarrow-array_1ga40e1dce8b43124c9710538842e68f944"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference [...]
<dd><p>Append a string of bytes to an array. </p>
<p>Returns NANOARROW_OK if value can be exactly represented by the underlying
storage type or EINVAL otherwise (e.g., the underlying array is not a binary,
string, large binary, large string, or fixed-size binary array, or value is the
wrong size for a fixed-size binary array). </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv422ArrowArrayAppendStringP10ArrowArray15ArrowStringView">
-<span
id="_CPPv322ArrowArrayAppendStringP10ArrowArray15ArrowStringView"></span><span
id="_CPPv222ArrowArrayAppendStringP10ArrowArray15ArrowStringView"></span><span
id="ArrowArrayAppendString__ArrowArrayP.ArrowStringView"></span><span
class="target"
id="group__nanoarrow-array_1gaa8c9118312eda7fc17fb6bf9d721ca9d"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="refere [...]
+<span
id="_CPPv322ArrowArrayAppendStringP10ArrowArray15ArrowStringView"></span><span
id="_CPPv222ArrowArrayAppendStringP10ArrowArray15ArrowStringView"></span><span
id="ArrowArrayAppendString__ArrowArrayP.ArrowStringView"></span><span
class="target"
id="group__nanoarrow-array_1gaa8c9118312eda7fc17fb6bf9d721ca9d"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="refere [...]
<dd><p>Append a string value to an array Returns NANOARROW_OK if value can be
exactly represented by the underlying storage type or EINVAL otherwise (e.g.,
the underlying array is not a string or large string array). </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv423ArrowArrayFinishElementP10ArrowArray">
-<span id="_CPPv323ArrowArrayFinishElementP10ArrowArray"></span><span
id="_CPPv223ArrowArrayFinishElementP10ArrowArray"></span><span
id="ArrowArrayFinishElement__ArrowArrayP"></span><span class="target"
id="group__nanoarrow-array_1ga357c8828c0ae590c5ae26eac22cce485"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv414ArrowErrorCode" ti [...]
+<span id="_CPPv323ArrowArrayFinishElementP10ArrowArray"></span><span
id="_CPPv223ArrowArrayFinishElementP10ArrowArray"></span><span
id="ArrowArrayFinishElement__ArrowArrayP"></span><span class="target"
id="group__nanoarrow-array_1ga357c8828c0ae590c5ae26eac22cce485"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv414ArrowErrorCode" ti [...]
<dd><p>Finish a nested array element. </p>
<p>Appends a non-null element to the array based on the first child’s current
length. Returns NANOARROW_OK if the item was successfully added or EINVAL if
the underlying storage type is not a struct, list, large list, or fixed-size
list, or if there was an attempt to add a struct or fixed-size list element
where the length of the child array(s) did not match the expected length. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv421ArrowArrayShrinkToFitP10ArrowArray">
-<span id="_CPPv321ArrowArrayShrinkToFitP10ArrowArray"></span><span
id="_CPPv221ArrowArrayShrinkToFitP10ArrowArray"></span><span
id="ArrowArrayShrinkToFit__ArrowArrayP"></span><span class="target"
id="group__nanoarrow-array_1gaa6e5c94f307218fcc22578cacf07cf81"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv414ArrowErrorCode" title="A [...]
+<span id="_CPPv321ArrowArrayShrinkToFitP10ArrowArray"></span><span
id="_CPPv221ArrowArrayShrinkToFitP10ArrowArray"></span><span
id="ArrowArrayShrinkToFit__ArrowArrayP"></span><span class="target"
id="group__nanoarrow-array_1gaa6e5c94f307218fcc22578cacf07cf81"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv414ArrowErrorCode" title="A [...]
<dd><p>Shrink buffer capacity to the size required. </p>
<p>Also applies shrinking to any child arrays. array must have been allocated
using ArrowArrayInit </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv424ArrowArrayFinishBuildingP10ArrowArrayP10ArrowError">
-<span
id="_CPPv324ArrowArrayFinishBuildingP10ArrowArrayP10ArrowError"></span><span
id="_CPPv224ArrowArrayFinishBuildingP10ArrowArrayP10ArrowError"></span><span
id="ArrowArrayFinishBuilding__ArrowArrayP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow-array_1ga830400ee3d4dc8cf64c5839a65bf3a34"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span class="w"> </span><spa [...]
-<dd><p>Finish building an ArrowArray. </p>
+<span
id="_CPPv324ArrowArrayFinishBuildingP10ArrowArrayP10ArrowError"></span><span
id="_CPPv224ArrowArrayFinishBuildingP10ArrowArrayP10ArrowError"></span><span
id="ArrowArrayFinishBuilding__ArrowArrayP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow-array_1ga830400ee3d4dc8cf64c5839a65bf3a34"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span
class="pre">ArrowErrorCode</span></span></a><span class="w"> </span><spa [...]
+<dd><p>Finish building an <a class="reference internal"
href="#struct_arrow_array"><span class="std std-ref">ArrowArray</span></a>. </p>
<p>Flushes any pointers from internal buffers that may have been reallocated
into the array->buffers array and checks the actual size of the buffers
against the expected size based on the final length. array must have been
allocated using <a class="reference internal"
href="#group__nanoarrow-array_1ga2c80b8404ed26bba84ba1a436c2ac26c"><span
class="std std-ref">ArrowArrayInit()</span></a> </p>
</dd></dl>
@@ -634,7 +634,7 @@
<dl>
<dt class="sig sig-object cpp">
<span class="target" id="group__nanoarrow-array-view"></span><em><span
class="pre">group</span></em> <span class="sig-name descname"><span
class="pre">nanoarrow-array-view</span></span></dt>
-<dd><p>These functions read and validate the contents ArrowArray structures.
</p>
+<dd><p>These functions read and validate the contents <a class="reference
internal" href="#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a> structures. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-enums">Enums</p>
<dl class="cpp enum">
@@ -685,8 +685,8 @@
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv428ArrowArrayViewInitFromSchemaP14ArrowArrayViewP11ArrowSchemaP10ArrowError">
-<span
id="_CPPv328ArrowArrayViewInitFromSchemaP14ArrowArrayViewP11ArrowSchemaP10ArrowError"></span><span
id="_CPPv228ArrowArrayViewInitFromSchemaP14ArrowArrayViewP11ArrowSchemaP10ArrowError"></span><span
id="ArrowArrayViewInitFromSchema__ArrowArrayViewP.ArrowSchemaP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow-array-view_1gaaba0e72bc11b0696fef0260d1ecd554f"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span cl [...]
-<dd><p>Initialize the contents of an <a class="reference internal"
href="#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a> from an ArrowSchema. </p>
+<span
id="_CPPv328ArrowArrayViewInitFromSchemaP14ArrowArrayViewP11ArrowSchemaP10ArrowError"></span><span
id="_CPPv228ArrowArrayViewInitFromSchemaP14ArrowArrayViewP11ArrowSchemaP10ArrowError"></span><span
id="ArrowArrayViewInitFromSchema__ArrowArrayViewP.ArrowSchemaP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow-array-view_1gaaba0e72bc11b0696fef0260d1ecd554f"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span cl [...]
+<dd><p>Initialize the contents of an <a class="reference internal"
href="#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a> from an <a class="reference internal"
href="#struct_arrow_schema"><span class="std std-ref">ArrowSchema</span></a>.
</p>
</dd></dl>
<dl class="cpp function">
@@ -704,8 +704,8 @@
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv422ArrowArrayViewSetArrayP14ArrowArrayViewP10ArrowArrayP10ArrowError">
-<span
id="_CPPv322ArrowArrayViewSetArrayP14ArrowArrayViewP10ArrowArrayP10ArrowError"></span><span
id="_CPPv222ArrowArrayViewSetArrayP14ArrowArrayViewP10ArrowArrayP10ArrowError"></span><span
id="ArrowArrayViewSetArray__ArrowArrayViewP.ArrowArrayP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow-array-view_1gada04cd33265cf33ded2701fb1e365648"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span class="pre">ArrowErrorC [...]
-<dd><p>Set buffer sizes and data pointers from an ArrowArray. </p>
+<span
id="_CPPv322ArrowArrayViewSetArrayP14ArrowArrayViewP10ArrowArrayP10ArrowError"></span><span
id="_CPPv222ArrowArrayViewSetArrayP14ArrowArrayViewP10ArrowArrayP10ArrowError"></span><span
id="ArrowArrayViewSetArray__ArrowArrayViewP.ArrowArrayP.ArrowErrorP"></span><span
class="target"
id="group__nanoarrow-array-view_1gada04cd33265cf33ded2701fb1e365648"></span><a
class="reference internal" href="#_CPPv414ArrowErrorCode"
title="ArrowErrorCode"><span class="n"><span class="pre">ArrowErrorC [...]
+<dd><p>Set buffer sizes and data pointers from an <a class="reference
internal" href="#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a>. </p>
</dd></dl>
<dl class="cpp function">
@@ -761,14 +761,14 @@
<span id="_CPPv314ArrowArrayView"></span><span
id="_CPPv214ArrowArrayView"></span><span id="ArrowArrayView"></span><span
class="target" id="struct_arrow_array_view"></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">ArrowArrayView</span></span></span><a class="headerlink"
href="#_CPPv414ArrowArrayView" title="Permalink to this definition">#</a><br
/></dt>
<dd><div class="docutils container">
<em>#include <nanoarrow_types.h></em></div>
-<p>A non-owning view of an ArrowArray. </p>
-<p>This data structure provides access to the values contained within an
ArrowArray with fields provided in a more readily-extractible form. You can
re-use an <a class="reference internal" href="#struct_arrow_array_view"><span
class="std std-ref">ArrowArrayView</span></a> for multiple ArrowArrays with the
same storage type, or use it to represent a hypothetical ArrowArray that does
not exist yet. </p>
+<p>A non-owning view of an <a class="reference internal"
href="#struct_arrow_array"><span class="std std-ref">ArrowArray</span></a>. </p>
+<p>This data structure provides access to the values contained within an <a
class="reference internal" href="#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a> with fields provided in a more
readily-extractible form. You can re-use an <a class="reference internal"
href="#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a> for multiple ArrowArrays with the same
storage type, or use it to represent a hypothetical <a class="reference
internal" href [...]
<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="_CPPv4N14ArrowArrayView5arrayE">
-<span id="_CPPv3N14ArrowArrayView5arrayE"></span><span
id="_CPPv2N14ArrowArrayView5arrayE"></span><span
id="ArrowArrayView::array__ArrowArrayP"></span><span class="target"
id="struct_arrow_array_view_1a3035bf0a4b816cf1ea002575fe1f7182"></span><span
class="k"><span class="pre">struct</span></span><span class="w"> </span><span
class="n"><span class="pre">ArrowArray</span></span><span class="w">
</span><span class="p"><span class="pre">*</span></span><span class="sig-name
descname"><span cl [...]
-<dd><p>The underlying ArrowArray or NULL if it has not been set. </p>
+<span id="_CPPv3N14ArrowArrayView5arrayE"></span><span
id="_CPPv2N14ArrowArrayView5arrayE"></span><span
id="ArrowArrayView::array__ArrowArrayP"></span><span class="target"
id="struct_arrow_array_view_1a3035bf0a4b816cf1ea002575fe1f7182"></span><span
class="k"><span class="pre">struct</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv410ArrowArray" title="ArrowArray"><span
class="n"><span class="pre">ArrowArray</span></span></a><span class="w">
</span><span cla [...]
+<dd><p>The underlying <a class="reference internal"
href="#struct_arrow_array"><span class="std std-ref">ArrowArray</span></a> or
NULL if it has not been set. </p>
</dd></dl>
<dl class="cpp var">
@@ -945,7 +945,7 @@
<dd><div class="docutils container">
<em>#include <nanoarrow_types.h></em></div>
<p>Array buffer allocation and deallocation. </p>
-<p>Container for allocate, reallocate, and free methods that can be used to
customize allocation and deallocation of buffers when constructing an
ArrowArray. </p>
+<p>Container for allocate, reallocate, and free methods that can be used to
customize allocation and deallocation of buffers when constructing an <a
class="reference internal" href="#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a>. </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">
@@ -1235,7 +1235,7 @@
<dl>
<dt class="sig sig-object cpp">
<span class="target" id="group__nanoarrow-malloc"></span><em><span
class="pre">group</span></em> <span class="sig-name descname"><span
class="pre">nanoarrow-malloc</span></span></dt>
-<dd><p>Non-buffer members of a struct ArrowSchema and struct ArrowArray must
be allocated using <a class="reference internal"
href="#group__nanoarrow-malloc_1gab05bc897baadee2d140b5bea9a846f7b"><span
class="std std-ref">ArrowMalloc()</span></a> or <a class="reference internal"
href="#group__nanoarrow-malloc_1ga3ae6c5f200450ea143c24613f4d115ac"><span
class="std std-ref">ArrowRealloc()</span></a> and freed using <a
class="reference internal" href="#group__nanoarrow-malloc_1gaa9552e61d8cce6
[...]
+<dd><p>Non-buffer members of a struct <a class="reference internal"
href="#struct_arrow_schema"><span class="std std-ref">ArrowSchema</span></a>
and struct <a class="reference internal" href="#struct_arrow_array"><span
class="std std-ref">ArrowArray</span></a> must be allocated using <a
class="reference internal"
href="#group__nanoarrow-malloc_1gab05bc897baadee2d140b5bea9a846f7b"><span
class="std std-ref">ArrowMalloc()</span></a> or <a class="reference internal"
href="#group__nanoarrow-m [...]
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-functions">Functions</p>
<dl class="cpp function">
@@ -1668,7 +1668,7 @@
<dd><div class="docutils container">
<em>#include <nanoarrow_types.h></em></div>
<p>A description of an arrangement of buffers. </p>
-<p>Contains the minimum amount of information required to calculate the size
of each buffer in an ArrowArray knowing only the length and offset of the
array. </p>
+<p>Contains the minimum amount of information required to calculate the size
of each buffer in an <a class="reference internal"
href="#struct_arrow_array"><span class="std std-ref">ArrowArray</span></a>
knowing only the length and offset of the array. </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">
@@ -1697,10 +1697,184 @@
</section>
<section id="arrow-c-data-interface">
<h2>Arrow C Data Interface<a class="headerlink" href="#arrow-c-data-interface"
title="Permalink to this heading">#</a></h2>
-<div class="admonition warning">
-<p class="admonition-title">Warning</p>
-<p>doxygengroup: Cannot find group “nanoarrow-arrow-cdata” in doxygen xml
output for project “nanoarrow_c” from directory: ../../src/apidoc/xml</p>
+<dl>
+<dt class="sig sig-object cpp">
+<span class="target" id="group__nanoarrow-arrow-cdata"></span><em><span
class="pre">group</span></em> <span class="sig-name descname"><span
class="pre">nanoarrow-arrow-cdata</span></span></dt>
+<dd><p>The Arrow C Data (<a class="reference external"
href="https://arrow.apache.org/docs/format/CDataInterface.html">https://arrow.apache.org/docs/format/CDataInterface.html</a>)
and Arrow C Stream (<a class="reference external"
href="https://arrow.apache.org/docs/format/CStreamInterface.html">https://arrow.apache.org/docs/format/CStreamInterface.html</a>)
interfaces are part of the Arrow Columnar Format specification (<a
class="reference external" href="https://arrow.apache.org/docs/f [...]
+<div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-defines">Defines</p>
+<dl class="cpp macro">
+<dt class="sig sig-object cpp" id="c.ARROW_C_DATA_INTERFACE">
+<span class="target"
id="group__nanoarrow-arrow-cdata_1ga62dff1b60bc389d2afc1f9845c8643c8"></span><span
class="sig-name descname"><span class="n"><span
class="pre">ARROW_C_DATA_INTERFACE</span></span></span><a class="headerlink"
href="#c.ARROW_C_DATA_INTERFACE" title="Permalink to this definition">#</a><br
/></dt>
+<dd></dd></dl>
+
+<dl class="cpp macro">
+<dt class="sig sig-object cpp" id="c.ARROW_FLAG_DICTIONARY_ORDERED">
+<span class="target"
id="group__nanoarrow-arrow-cdata_1gaeb5dd606ecbde0a6d99711756a6da1c1"></span><span
class="sig-name descname"><span class="n"><span
class="pre">ARROW_FLAG_DICTIONARY_ORDERED</span></span></span><a
class="headerlink" href="#c.ARROW_FLAG_DICTIONARY_ORDERED" title="Permalink to
this definition">#</a><br /></dt>
+<dd></dd></dl>
+
+<dl class="cpp macro">
+<dt class="sig sig-object cpp" id="c.ARROW_FLAG_NULLABLE">
+<span class="target"
id="group__nanoarrow-arrow-cdata_1ga5e08d487c628beadce561c5fd05ffab0"></span><span
class="sig-name descname"><span class="n"><span
class="pre">ARROW_FLAG_NULLABLE</span></span></span><a class="headerlink"
href="#c.ARROW_FLAG_NULLABLE" title="Permalink to this definition">#</a><br
/></dt>
+<dd></dd></dl>
+
+<dl class="cpp macro">
+<dt class="sig sig-object cpp" id="c.ARROW_FLAG_MAP_KEYS_SORTED">
+<span class="target"
id="group__nanoarrow-arrow-cdata_1ga4a8b190bb8b285f924648553ee468171"></span><span
class="sig-name descname"><span class="n"><span
class="pre">ARROW_FLAG_MAP_KEYS_SORTED</span></span></span><a
class="headerlink" href="#c.ARROW_FLAG_MAP_KEYS_SORTED" title="Permalink to
this definition">#</a><br /></dt>
+<dd></dd></dl>
+
+<dl class="cpp macro">
+<dt class="sig sig-object cpp" id="c.ARROW_C_STREAM_INTERFACE">
+<span class="target"
id="group__nanoarrow-arrow-cdata_1gaacad63acda264a0ae393bd842a77220d"></span><span
class="sig-name descname"><span class="n"><span
class="pre">ARROW_C_STREAM_INTERFACE</span></span></span><a class="headerlink"
href="#c.ARROW_C_STREAM_INTERFACE" title="Permalink to this
definition">#</a><br /></dt>
+<dd></dd></dl>
+
+</div>
+<dl class="cpp struct">
+<dt class="sig sig-object cpp" id="_CPPv411ArrowSchema">
+<span id="_CPPv311ArrowSchema"></span><span
id="_CPPv211ArrowSchema"></span><span id="ArrowSchema"></span><span
class="target" id="struct_arrow_schema"></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">ArrowSchema</span></span></span><a
class="headerlink" href="#_CPPv411ArrowSchema" title="Permalink to this
definition">#</a><br /></dt>
+<dd><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="_CPPv4N11ArrowSchema6formatE">
+<span id="_CPPv3N11ArrowSchema6formatE"></span><span
id="_CPPv2N11ArrowSchema6formatE"></span><span
id="ArrowSchema::format__cCP"></span><span class="target"
id="struct_arrow_schema_1ab5d0127ee66cd298683f2a2d2aae5788"></span><span
class="k"><span class="pre">const</span></span><span class="w"> </span><span
class="kt"><span class="pre">char</span></span><span class="w"> </span><span
class="p"><span class="pre">*</span></span><span class="sig-name
descname"><span class="n"><span class="pre [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N11ArrowSchema4nameE">
+<span id="_CPPv3N11ArrowSchema4nameE"></span><span
id="_CPPv2N11ArrowSchema4nameE"></span><span
id="ArrowSchema::name__cCP"></span><span class="target"
id="struct_arrow_schema_1aa6dae1b0e311f4b30a9e2ca002ad8d22"></span><span
class="k"><span class="pre">const</span></span><span class="w"> </span><span
class="kt"><span class="pre">char</span></span><span class="w"> </span><span
class="p"><span class="pre">*</span></span><span class="sig-name
descname"><span class="n"><span class="pre">name [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N11ArrowSchema8metadataE">
+<span id="_CPPv3N11ArrowSchema8metadataE"></span><span
id="_CPPv2N11ArrowSchema8metadataE"></span><span
id="ArrowSchema::metadata__cCP"></span><span class="target"
id="struct_arrow_schema_1a51ceb37c71e94fac6b6e14a3d8e3b50c"></span><span
class="k"><span class="pre">const</span></span><span class="w"> </span><span
class="kt"><span class="pre">char</span></span><span class="w"> </span><span
class="p"><span class="pre">*</span></span><span class="sig-name
descname"><span class="n"><span clas [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N11ArrowSchema5flagsE">
+<span id="_CPPv3N11ArrowSchema5flagsE"></span><span
id="_CPPv2N11ArrowSchema5flagsE"></span><span
id="ArrowSchema::flags__int64_t"></span><span class="target"
id="struct_arrow_schema_1a15b2e390fc6708b23ad29c69e136163c"></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">flags</span></span></span><a class="headerlink"
href="#_CPPv4N11ArrowSchema5flagsE" title="Permalink to this definition"> [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N11ArrowSchema10n_childrenE">
+<span id="_CPPv3N11ArrowSchema10n_childrenE"></span><span
id="_CPPv2N11ArrowSchema10n_childrenE"></span><span
id="ArrowSchema::n_children__int64_t"></span><span class="target"
id="struct_arrow_schema_1a88a53da5862c6d2f66692910ce5e5c42"></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">n_children</span></span></span><a class="headerlink"
href="#_CPPv4N11ArrowSchema10n_childrenE" title="Pe [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N11ArrowSchema8childrenE">
+<span id="_CPPv3N11ArrowSchema8childrenE"></span><span
id="_CPPv2N11ArrowSchema8childrenE"></span><span
id="ArrowSchema::children__ArrowSchemaPP"></span><span class="target"
id="struct_arrow_schema_1ae0ba059e1e9a6879fc231f3475644c1a"></span><span
class="k"><span class="pre">struct</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv411ArrowSchema"
title="ArrowSchema"><span class="n"><span
class="pre">ArrowSchema</span></span></a><span class="w"> </span><span cl [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N11ArrowSchema10dictionaryE">
+<span id="_CPPv3N11ArrowSchema10dictionaryE"></span><span
id="_CPPv2N11ArrowSchema10dictionaryE"></span><span
id="ArrowSchema::dictionary__ArrowSchemaP"></span><span class="target"
id="struct_arrow_schema_1ac608367ec75500cd6322cf6bf45bc4cf"></span><span
class="k"><span class="pre">struct</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv411ArrowSchema"
title="ArrowSchema"><span class="n"><span
class="pre">ArrowSchema</span></span></a><span class="w"> </span>< [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N11ArrowSchema7releaseE">
+<span id="_CPPv3N11ArrowSchema7releaseE"></span><span
id="_CPPv2N11ArrowSchema7releaseE"></span><span class="target"
id="struct_arrow_schema_1ad471ae72074febbeaf80288f2f673c57"></span><span
class="kt"><span class="pre">void</span></span><span class="w"> </span><span
class="p"><span class="pre">(</span></span><span class="p"><span
class="pre">*</span></span><span class="sig-name descname"><span
class="n"><span class="pre">release</span></span></span><span class="p"><span
class="pre">)</sp [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N11ArrowSchema12private_dataE">
+<span id="_CPPv3N11ArrowSchema12private_dataE"></span><span
id="_CPPv2N11ArrowSchema12private_dataE"></span><span
id="ArrowSchema::private_data__voidP"></span><span class="target"
id="struct_arrow_schema_1ab385d6a15b6dc46194dcc4286f36b767"></span><span
class="kt"><span class="pre">void</span></span><span class="w"> </span><span
class="p"><span class="pre">*</span></span><span class="sig-name
descname"><span class="n"><span class="pre">private_data</span></span></span><a
class="headerlink [...]
+<dd></dd></dl>
+
</div>
+</dd></dl>
+
+<dl class="cpp struct">
+<dt class="sig sig-object cpp" id="_CPPv410ArrowArray">
+<span id="_CPPv310ArrowArray"></span><span
id="_CPPv210ArrowArray"></span><span id="ArrowArray"></span><span
class="target" id="struct_arrow_array"></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">ArrowArray</span></span></span><a
class="headerlink" href="#_CPPv410ArrowArray" title="Permalink to this
definition">#</a><br /></dt>
+<dd><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="_CPPv4N10ArrowArray6lengthE">
+<span id="_CPPv3N10ArrowArray6lengthE"></span><span
id="_CPPv2N10ArrowArray6lengthE"></span><span
id="ArrowArray::length__int64_t"></span><span class="target"
id="struct_arrow_array_1ad36c74977f20ab8dbb3c6273e30a6719"></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">length</span></span></span><a class="headerlink"
href="#_CPPv4N10ArrowArray6lengthE" title="Permalink to this definition"> [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N10ArrowArray10null_countE">
+<span id="_CPPv3N10ArrowArray10null_countE"></span><span
id="_CPPv2N10ArrowArray10null_countE"></span><span
id="ArrowArray::null_count__int64_t"></span><span class="target"
id="struct_arrow_array_1a49fbb08c99e0f8d2a68c2f3a24aa2a76"></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">null_count</span></span></span><a class="headerlink"
href="#_CPPv4N10ArrowArray10null_countE" title="Permali [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N10ArrowArray6offsetE">
+<span id="_CPPv3N10ArrowArray6offsetE"></span><span
id="_CPPv2N10ArrowArray6offsetE"></span><span
id="ArrowArray::offset__int64_t"></span><span class="target"
id="struct_arrow_array_1aa1b045f8e085dbca894bb9c3900c007e"></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">offset</span></span></span><a class="headerlink"
href="#_CPPv4N10ArrowArray6offsetE" title="Permalink to this definition"> [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N10ArrowArray9n_buffersE">
+<span id="_CPPv3N10ArrowArray9n_buffersE"></span><span
id="_CPPv2N10ArrowArray9n_buffersE"></span><span
id="ArrowArray::n_buffers__int64_t"></span><span class="target"
id="struct_arrow_array_1acb8b049eef21583b2f9f650d36fff2f6"></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">n_buffers</span></span></span><a class="headerlink"
href="#_CPPv4N10ArrowArray9n_buffersE" title="Permalink to th [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N10ArrowArray10n_childrenE">
+<span id="_CPPv3N10ArrowArray10n_childrenE"></span><span
id="_CPPv2N10ArrowArray10n_childrenE"></span><span
id="ArrowArray::n_children__int64_t"></span><span class="target"
id="struct_arrow_array_1a39a2697ceead3e08c0b89339c2aacb37"></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">n_children</span></span></span><a class="headerlink"
href="#_CPPv4N10ArrowArray10n_childrenE" title="Permali [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N10ArrowArray7buffersE">
+<span id="_CPPv3N10ArrowArray7buffersE"></span><span
id="_CPPv2N10ArrowArray7buffersE"></span><span
id="ArrowArray::buffers__voidCPP"></span><span class="target"
id="struct_arrow_array_1aa6766338a7beb165e32255cbd641f569"></span><span
class="k"><span class="pre">const</span></span><span class="w"> </span><span
class="kt"><span class="pre">void</span></span><span class="w"> </span><span
class="p"><span class="pre">*</span></span><span class="p"><span
class="pre">*</span></span><span class= [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N10ArrowArray8childrenE">
+<span id="_CPPv3N10ArrowArray8childrenE"></span><span
id="_CPPv2N10ArrowArray8childrenE"></span><span
id="ArrowArray::children__ArrowArrayPP"></span><span class="target"
id="struct_arrow_array_1a4fb07be9899001e57c9ab0509396ffb8"></span><span
class="k"><span class="pre">struct</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv410ArrowArray" title="ArrowArray"><span
class="n"><span class="pre">ArrowArray</span></span></a><span class="w">
</span><span class="p"> [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N10ArrowArray10dictionaryE">
+<span id="_CPPv3N10ArrowArray10dictionaryE"></span><span
id="_CPPv2N10ArrowArray10dictionaryE"></span><span
id="ArrowArray::dictionary__ArrowArrayP"></span><span class="target"
id="struct_arrow_array_1aa4b987f9f4c600b5accc9830006b4da8"></span><span
class="k"><span class="pre">struct</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv410ArrowArray" title="ArrowArray"><span
class="n"><span class="pre">ArrowArray</span></span></a><span class="w">
</span><span cla [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N10ArrowArray7releaseE">
+<span id="_CPPv3N10ArrowArray7releaseE"></span><span
id="_CPPv2N10ArrowArray7releaseE"></span><span class="target"
id="struct_arrow_array_1a03ad36422f651c0b0ccd9ab9c5b7d5d3"></span><span
class="kt"><span class="pre">void</span></span><span class="w"> </span><span
class="p"><span class="pre">(</span></span><span class="p"><span
class="pre">*</span></span><span class="sig-name descname"><span
class="n"><span class="pre">release</span></span></span><span class="p"><span
class="pre">)</span> [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N10ArrowArray12private_dataE">
+<span id="_CPPv3N10ArrowArray12private_dataE"></span><span
id="_CPPv2N10ArrowArray12private_dataE"></span><span
id="ArrowArray::private_data__voidP"></span><span class="target"
id="struct_arrow_array_1a1f2d5a334bb41924c4822bbfc7aec63e"></span><span
class="kt"><span class="pre">void</span></span><span class="w"> </span><span
class="p"><span class="pre">*</span></span><span class="sig-name
descname"><span class="n"><span class="pre">private_data</span></span></span><a
class="headerlink" hr [...]
+<dd></dd></dl>
+
+</div>
+</dd></dl>
+
+<dl class="cpp struct">
+<dt class="sig sig-object cpp" id="_CPPv416ArrowArrayStream">
+<span id="_CPPv316ArrowArrayStream"></span><span
id="_CPPv216ArrowArrayStream"></span><span id="ArrowArrayStream"></span><span
class="target" id="struct_arrow_array_stream"></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">ArrowArrayStream</span></span></span><a class="headerlink"
href="#_CPPv416ArrowArrayStream" title="Permalink to this definition">#</a><br
/></dt>
+<dd><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="_CPPv4N16ArrowArrayStream10get_schemaE">
+<span id="_CPPv3N16ArrowArrayStream10get_schemaE"></span><span
id="_CPPv2N16ArrowArrayStream10get_schemaE"></span><span class="target"
id="struct_arrow_array_stream_1ae3a7b23fdfe446a3d095342c39d981c9"></span><span
class="kt"><span class="pre">int</span></span><span class="w"> </span><span
class="p"><span class="pre">(</span></span><span class="p"><span
class="pre">*</span></span><span class="sig-name descname"><span
class="n"><span class="pre">get_schema</span></span></span><span class=" [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N16ArrowArrayStream8get_nextE">
+<span id="_CPPv3N16ArrowArrayStream8get_nextE"></span><span
id="_CPPv2N16ArrowArrayStream8get_nextE"></span><span class="target"
id="struct_arrow_array_stream_1a13f0d5da2fc463ce35463757ddb5d36e"></span><span
class="kt"><span class="pre">int</span></span><span class="w"> </span><span
class="p"><span class="pre">(</span></span><span class="p"><span
class="pre">*</span></span><span class="sig-name descname"><span
class="n"><span class="pre">get_next</span></span></span><span class="p"><span
[...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N16ArrowArrayStream14get_last_errorE">
+<span id="_CPPv3N16ArrowArrayStream14get_last_errorE"></span><span
id="_CPPv2N16ArrowArrayStream14get_last_errorE"></span><span class="target"
id="struct_arrow_array_stream_1a7268c69a6b60a4ba9a9bbff1f4b87664"></span><span
class="k"><span class="pre">const</span></span><span class="w"> </span><span
class="kt"><span class="pre">char</span></span><span class="w"> </span><span
class="p"><span class="pre">*</span></span><span class="p"><span
class="pre">(</span></span><span class="p"><span cl [...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N16ArrowArrayStream7releaseE">
+<span id="_CPPv3N16ArrowArrayStream7releaseE"></span><span
id="_CPPv2N16ArrowArrayStream7releaseE"></span><span class="target"
id="struct_arrow_array_stream_1a7fe27fba0eed01ed6f63591b22c6b859"></span><span
class="kt"><span class="pre">void</span></span><span class="w"> </span><span
class="p"><span class="pre">(</span></span><span class="p"><span
class="pre">*</span></span><span class="sig-name descname"><span
class="n"><span class="pre">release</span></span></span><span class="p"><span c
[...]
+<dd></dd></dl>
+
+<dl class="cpp var">
+<dt class="sig sig-object cpp" id="_CPPv4N16ArrowArrayStream12private_dataE">
+<span id="_CPPv3N16ArrowArrayStream12private_dataE"></span><span
id="_CPPv2N16ArrowArrayStream12private_dataE"></span><span
id="ArrowArrayStream::private_data__voidP"></span><span class="target"
id="struct_arrow_array_stream_1a35d4fb572d51736c6c447f64406b50d9"></span><span
class="kt"><span class="pre">void</span></span><span class="w"> </span><span
class="p"><span class="pre">*</span></span><span class="sig-name
descname"><span class="n"><span class="pre">private_data</span></span></span
[...]
+<dd></dd></dl>
+
+</div>
+</dd></dl>
+
+</dd></dl>
+
</section>
</section>
diff --git a/dev/cpp.html b/dev/cpp.html
index 84bbfe3..7e5b0a6 100644
--- a/dev/cpp.html
+++ b/dev/cpp.html
@@ -279,31 +279,72 @@
<section id="owning-object-wrappers">
<h2>Owning object wrappers<a class="headerlink" href="#owning-object-wrappers"
title="Permalink to this heading">#</a></h2>
-<div class="admonition warning">
-<p class="admonition-title">Warning</p>
-<p>doxygengroup: Cannot find group “nanoarrow_hpp-unique” in doxygen xml
output for project “nanoarrow_c” from directory: ../../src/apidoc/xml</p>
+<dl>
+<dt class="sig sig-object cpp">
+<span class="target" id="group__nanoarrow__hpp-unique"></span><em><span
class="pre">group</span></em> <span class="sig-name descname"><span
class="pre">nanoarrow_hpp-unique</span></span></dt>
+<dd><p>The Arrow C Data interface, the Arrow C Stream interface, and the
nanoarrow C library use stack-allocatable objects, some of which require
initialization or cleanup. </p>
+<div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-typedefs">Typedefs</p>
+<dl class="cpp type">
+<dt class="sig sig-object cpp" id="_CPPv412UniqueSchema">
+<span id="_CPPv312UniqueSchema"></span><span
id="_CPPv212UniqueSchema"></span><span class="target"
id="group__nanoarrow__hpp-unique_1ga912b1e6bbdeb87941b95cb4659e6ee6e"></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">UniqueSchema</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">internal< [...]
+<dd><p>Class wrapping a unique struct <a class="reference internal"
href="c.html#struct_arrow_schema"><span class="std
std-ref">ArrowSchema</span></a>. </p>
+</dd></dl>
+
+<dl class="cpp type">
+<dt class="sig sig-object cpp" id="_CPPv411UniqueArray">
+<span id="_CPPv311UniqueArray"></span><span
id="_CPPv211UniqueArray"></span><span class="target"
id="group__nanoarrow__hpp-unique_1ga93f47526e4b64c67ac0c2120cdd5a32a"></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">UniqueArray</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">internal</sp [...]
+<dd><p>Class wrapping a unique struct <a class="reference internal"
href="c.html#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a>. </p>
+</dd></dl>
+
+<dl class="cpp type">
+<dt class="sig sig-object cpp" id="_CPPv417UniqueArrayStream">
+<span id="_CPPv317UniqueArrayStream"></span><span
id="_CPPv217UniqueArrayStream"></span><span class="target"
id="group__nanoarrow__hpp-unique_1gaf77a45c6e828bc32ad9dda17467e2de6"></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">UniqueArrayStream</span></span></span><span class="w"> </span><span
class="p"><span class="pre">=</span></span><span class="w"> </span><span
class="n"><span class= [...]
+<dd><p>Class wrapping a unique struct <a class="reference internal"
href="c.html#struct_arrow_array_stream"><span class="std
std-ref">ArrowArrayStream</span></a>. </p>
+</dd></dl>
+
+<dl class="cpp type">
+<dt class="sig sig-object cpp" id="_CPPv412UniqueBuffer">
+<span id="_CPPv312UniqueBuffer"></span><span
id="_CPPv212UniqueBuffer"></span><span class="target"
id="group__nanoarrow__hpp-unique_1gabc8af265788a5845e13ee5e7f2aaeb6d"></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">UniqueBuffer</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">internal< [...]
+<dd><p>Class wrapping a unique struct <a class="reference internal"
href="c.html#struct_arrow_buffer"><span class="std
std-ref">ArrowBuffer</span></a>. </p>
+</dd></dl>
+
+<dl class="cpp type">
+<dt class="sig sig-object cpp" id="_CPPv412UniqueBitmap">
+<span id="_CPPv312UniqueBitmap"></span><span
id="_CPPv212UniqueBitmap"></span><span class="target"
id="group__nanoarrow__hpp-unique_1ga363de46854c2455c5849df0495f9a88b"></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">UniqueBitmap</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">internal< [...]
+<dd><p>Class wrapping a unique struct <a class="reference internal"
href="c.html#struct_arrow_bitmap"><span class="std
std-ref">ArrowBitmap</span></a>. </p>
+</dd></dl>
+
+<dl class="cpp type">
+<dt class="sig sig-object cpp" id="_CPPv415UniqueArrayView">
+<span id="_CPPv315UniqueArrayView"></span><span
id="_CPPv215UniqueArrayView"></span><span class="target"
id="group__nanoarrow__hpp-unique_1ga7171390b0258c15dee585010f9358e5b"></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">UniqueArrayView</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"> [...]
+<dd><p>Class wrapping a unique struct <a class="reference internal"
href="c.html#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a>. </p>
+</dd></dl>
+
</div>
+</dd></dl>
+
</section>
<section id="array-stream-utilities">
<h2>Array Stream utilities<a class="headerlink" href="#array-stream-utilities"
title="Permalink to this heading">#</a></h2>
<dl>
<dt class="sig sig-object cpp">
<span class="target" id="group__nanoarrow__hpp-array-stream"></span><em><span
class="pre">group</span></em> <span class="sig-name descname"><span
class="pre">nanoarrow_hpp-array-stream</span></span></dt>
-<dd><p>These classes provide simple struct ArrowArrayStream implementations
that can be extended to help simplify the process of creating a valid
ArrowArrayStream implementation or used as-is for testing. </p>
+<dd><p>These classes provide simple struct <a class="reference internal"
href="c.html#struct_arrow_array_stream"><span class="std
std-ref">ArrowArrayStream</span></a> implementations that can be extended to
help simplify the process of creating a valid <a class="reference internal"
href="c.html#struct_arrow_array_stream"><span class="std
std-ref">ArrowArrayStream</span></a> implementation or used as-is for testing.
</p>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv4N9nanoarrow16EmptyArrayStreamE">
<span id="_CPPv3N9nanoarrow16EmptyArrayStreamE"></span><span
id="_CPPv2N9nanoarrow16EmptyArrayStreamE"></span><span
id="nanoarrow::EmptyArrayStream"></span><span class="target"
id="classnanoarrow_1_1_empty_array_stream"></span><span class="k"><span
class="pre">class</span></span><span class="w"> </span><span class="sig-name
descname"><span class="n"><span
class="pre">EmptyArrayStream</span></span></span><a class="headerlink"
href="#_CPPv4N9nanoarrow16EmptyArrayStreamE" title="Permalink t [...]
<dd><div class="docutils container">
<em>#include <nanoarrow.hpp></em></div>
<p>An empty array stream. </p>
-<p>This class can be constructed from an enum ArrowType or struct ArrowSchema
and implements a default get_next() method that always marks the output
ArrowArray as released. This class can be extended with an implementation of
get_next() for a custom source. </p>
+<p>This class can be constructed from an enum ArrowType or struct <a
class="reference internal" href="c.html#struct_arrow_schema"><span class="std
std-ref">ArrowSchema</span></a> and implements a default get_next() method that
always marks the output <a class="reference internal"
href="c.html#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a> as released. This class can be extended with an
implementation of get_next() for a custom source. </p>
<p>Subclassed by <a class="reference internal"
href="#classnanoarrow_1_1_vector_array_stream"><span class="std
std-ref">nanoarrow::VectorArrayStream</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-public-static-functions">Public Static Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv4N9nanoarrow16EmptyArrayStream10MakeUniqueEP11ArrowSchema">
-<span
id="_CPPv3N9nanoarrow16EmptyArrayStream10MakeUniqueEP11ArrowSchema"></span><span
id="_CPPv2N9nanoarrow16EmptyArrayStream10MakeUniqueEP11ArrowSchema"></span><span
id="nanoarrow::EmptyArrayStream::MakeUnique__ArrowSchemaP"></span><span
class="target"
id="classnanoarrow_1_1_empty_array_stream_1abeb0b129442c5a78db5cf95fa380f066"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </s [...]
-<dd><p>Create an empty UniqueArrayStream from a struct ArrowSchema. </p>
+<span
id="_CPPv3N9nanoarrow16EmptyArrayStream10MakeUniqueEP11ArrowSchema"></span><span
id="_CPPv2N9nanoarrow16EmptyArrayStream10MakeUniqueEP11ArrowSchema"></span><span
id="nanoarrow::EmptyArrayStream::MakeUnique__ArrowSchemaP"></span><span
class="target"
id="classnanoarrow_1_1_empty_array_stream_1abeb0b129442c5a78db5cf95fa380f066"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </s [...]
+<dd><p>Create an empty UniqueArrayStream from a struct <a class="reference
internal" href="c.html#struct_arrow_schema"><span class="std
std-ref">ArrowSchema</span></a>. </p>
<p>This object takes ownership of the schema and marks the source schema as
released. </p>
</dd></dl>
@@ -315,19 +356,19 @@
<span id="_CPPv3N9nanoarrow17VectorArrayStreamE"></span><span
id="_CPPv2N9nanoarrow17VectorArrayStreamE"></span><span
id="nanoarrow::VectorArrayStream"></span><span class="target"
id="classnanoarrow_1_1_vector_array_stream"></span><span class="k"><span
class="pre">class</span></span><span class="w"> </span><span class="sig-name
descname"><span class="n"><span
class="pre">VectorArrayStream</span></span></span><span class="w"> </span><span
class="p"><span class="pre">:</span></span><span c [...]
<dd><div class="docutils container">
<em>#include <nanoarrow.hpp></em></div>
-<p>Implementation of an ArrowArrayStream backed by a vector of ArrowArray
objects. </p>
+<p>Implementation of an <a class="reference internal"
href="c.html#struct_arrow_array_stream"><span class="std
std-ref">ArrowArrayStream</span></a> backed by a vector of <a class="reference
internal" href="c.html#struct_arrow_array"><span class="std
std-ref">ArrowArray</span></a> objects. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-public-static-functions">Public Static Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv4N9nanoarrow17VectorArrayStream10MakeUniqueEP11ArrowSchemaP10ArrowArray">
-<span
id="_CPPv3N9nanoarrow17VectorArrayStream10MakeUniqueEP11ArrowSchemaP10ArrowArray"></span><span
id="_CPPv2N9nanoarrow17VectorArrayStream10MakeUniqueEP11ArrowSchemaP10ArrowArray"></span><span
id="nanoarrow::VectorArrayStream::MakeUnique__ArrowSchemaP.ArrowArrayP"></span><span
class="target"
id="classnanoarrow_1_1_vector_array_stream_1ada8ae27d26108887f3ca63bf1db7c87a"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre [...]
+<span
id="_CPPv3N9nanoarrow17VectorArrayStream10MakeUniqueEP11ArrowSchemaP10ArrowArray"></span><span
id="_CPPv2N9nanoarrow17VectorArrayStream10MakeUniqueEP11ArrowSchemaP10ArrowArray"></span><span
id="nanoarrow::VectorArrayStream::MakeUnique__ArrowSchemaP.ArrowArrayP"></span><span
class="target"
id="classnanoarrow_1_1_vector_array_stream_1ada8ae27d26108887f3ca63bf1db7c87a"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre [...]
<dd><p>Create a UniqueArrowArrayStream from an existing array. </p>
<p>Takes ownership of the schema and the array. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv4N9nanoarrow17VectorArrayStream10MakeUniqueEP11ArrowSchemaNSt6vectorI11UniqueArrayEE">
-<span
id="_CPPv3N9nanoarrow17VectorArrayStream10MakeUniqueEP11ArrowSchemaNSt6vectorI11UniqueArrayEE"></span><span
id="_CPPv2N9nanoarrow17VectorArrayStream10MakeUniqueEP11ArrowSchemaNSt6vectorI11UniqueArrayEE"></span><span
id="nanoarrow::VectorArrayStream::MakeUnique__ArrowSchemaP.std::vector:UniqueArray:"></span><span
class="target"
id="classnanoarrow_1_1_vector_array_stream_1a59fbc6edd7957bed81f5b82f791d8668"></span><span
class="k"><span class="pre">static</span></span><span class="w"> [...]
+<span
id="_CPPv3N9nanoarrow17VectorArrayStream10MakeUniqueEP11ArrowSchemaNSt6vectorI11UniqueArrayEE"></span><span
id="_CPPv2N9nanoarrow17VectorArrayStream10MakeUniqueEP11ArrowSchemaNSt6vectorI11UniqueArrayEE"></span><span
id="nanoarrow::VectorArrayStream::MakeUnique__ArrowSchemaP.std::vector:UniqueArray:"></span><span
class="target"
id="classnanoarrow_1_1_vector_array_stream_1a59fbc6edd7957bed81f5b82f791d8668"></span><span
class="k"><span class="pre">static</span></span><span class="w"> [...]
<dd><p>Create a UniqueArrowArrayStream from existing arrays. </p>
<p>This object takes ownership of the schema and arrays. </p>
</dd></dl>
@@ -347,47 +388,47 @@
<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-functions">Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv412init_pointerP11ArrowSchema">
-<span id="_CPPv312init_pointerP11ArrowSchema"></span><span
id="_CPPv212init_pointerP11ArrowSchema"></span><span
id="init_pointer__ArrowSchemaP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1gac4aeb1701efac5f348b9d73c348159a4"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="kt"><span class="pre">void</span></span><span class="w"> </span><spa
[...]
+<span id="_CPPv312init_pointerP11ArrowSchema"></span><span
id="_CPPv212init_pointerP11ArrowSchema"></span><span
id="init_pointer__ArrowSchemaP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1gac4aeb1701efac5f348b9d73c348159a4"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="kt"><span class="pre">void</span></span><span class="w"> </span><spa
[...]
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv412move_pointerP11ArrowSchemaP11ArrowSchema">
-<span id="_CPPv312move_pointerP11ArrowSchemaP11ArrowSchema"></span><span
id="_CPPv212move_pointerP11ArrowSchemaP11ArrowSchema"></span><span
id="move_pointer__ArrowSchemaP.ArrowSchemaP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga9ee5c8441d2dd6b4e93bfe4e9727697c"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="kt"><span class="pre">void< [...]
+<span id="_CPPv312move_pointerP11ArrowSchemaP11ArrowSchema"></span><span
id="_CPPv212move_pointerP11ArrowSchemaP11ArrowSchema"></span><span
id="move_pointer__ArrowSchemaP.ArrowSchemaP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga9ee5c8441d2dd6b4e93bfe4e9727697c"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="kt"><span class="pre">void< [...]
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv415release_pointerP11ArrowSchema">
-<span id="_CPPv315release_pointerP11ArrowSchema"></span><span
id="_CPPv215release_pointerP11ArrowSchema"></span><span
id="release_pointer__ArrowSchemaP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga7df90210779a09d09a11cd9dbe7b6893"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="kt"><span class="pre">void</span></span><span class="w"> </ [...]
+<span id="_CPPv315release_pointerP11ArrowSchema"></span><span
id="_CPPv215release_pointerP11ArrowSchema"></span><span
id="release_pointer__ArrowSchemaP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga7df90210779a09d09a11cd9dbe7b6893"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="kt"><span class="pre">void</span></span><span class="w"> </ [...]
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv412init_pointerP10ArrowArray">
-<span id="_CPPv312init_pointerP10ArrowArray"></span><span
id="_CPPv212init_pointerP10ArrowArray"></span><span
id="init_pointer__ArrowArrayP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga560e8a28f8e52d5c738753c497cd9d6c"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="kt"><span class="pre">void</span></span><span class="w"> </span><span c
[...]
+<span id="_CPPv312init_pointerP10ArrowArray"></span><span
id="_CPPv212init_pointerP10ArrowArray"></span><span
id="init_pointer__ArrowArrayP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga560e8a28f8e52d5c738753c497cd9d6c"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="kt"><span class="pre">void</span></span><span class="w"> </span><span c
[...]
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv412move_pointerP10ArrowArrayP10ArrowArray">
-<span id="_CPPv312move_pointerP10ArrowArrayP10ArrowArray"></span><span
id="_CPPv212move_pointerP10ArrowArrayP10ArrowArray"></span><span
id="move_pointer__ArrowArrayP.ArrowArrayP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga1d2b6e53856f53e939c8f04146473d13"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="kt"><span class="pre">void</span> [...]
+<span id="_CPPv312move_pointerP10ArrowArrayP10ArrowArray"></span><span
id="_CPPv212move_pointerP10ArrowArrayP10ArrowArray"></span><span
id="move_pointer__ArrowArrayP.ArrowArrayP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga1d2b6e53856f53e939c8f04146473d13"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="kt"><span class="pre">void</span> [...]
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv415release_pointerP10ArrowArray">
-<span id="_CPPv315release_pointerP10ArrowArray"></span><span
id="_CPPv215release_pointerP10ArrowArray"></span><span
id="release_pointer__ArrowArrayP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga40a95fbafcea5081f24d71f5fe371c88"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="kt"><span class="pre">void</span></span><span class="w"> </spa [...]
+<span id="_CPPv315release_pointerP10ArrowArray"></span><span
id="_CPPv215release_pointerP10ArrowArray"></span><span
id="release_pointer__ArrowArrayP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga40a95fbafcea5081f24d71f5fe371c88"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="kt"><span class="pre">void</span></span><span class="w"> </spa [...]
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv412init_pointerP16ArrowArrayStream">
-<span id="_CPPv312init_pointerP16ArrowArrayStream"></span><span
id="_CPPv212init_pointerP16ArrowArrayStream"></span><span
id="init_pointer__ArrowArrayStreamP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga69bf02bdb2db20e166b6d85dac993acf"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="kt"><span class="pre">void</span></span><span class=" [...]
+<span id="_CPPv312init_pointerP16ArrowArrayStream"></span><span
id="_CPPv212init_pointerP16ArrowArrayStream"></span><span
id="init_pointer__ArrowArrayStreamP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga69bf02bdb2db20e166b6d85dac993acf"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="kt"><span class="pre">void</span></span><span class=" [...]
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv412move_pointerP16ArrowArrayStreamP16ArrowArrayStream">
-<span
id="_CPPv312move_pointerP16ArrowArrayStreamP16ArrowArrayStream"></span><span
id="_CPPv212move_pointerP16ArrowArrayStreamP16ArrowArrayStream"></span><span
id="move_pointer__ArrowArrayStreamP.ArrowArrayStreamP"></span><span
class="target"
id="group__nanoarrow__hpp-unique__base_1gaf551b40262fce6c49ae3758fecc0200a"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
clas [...]
+<span
id="_CPPv312move_pointerP16ArrowArrayStreamP16ArrowArrayStream"></span><span
id="_CPPv212move_pointerP16ArrowArrayStreamP16ArrowArrayStream"></span><span
id="move_pointer__ArrowArrayStreamP.ArrowArrayStreamP"></span><span
class="target"
id="group__nanoarrow__hpp-unique__base_1gaf551b40262fce6c49ae3758fecc0200a"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
clas [...]
<dd></dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv415release_pointerP16ArrowArrayStream">
-<span id="_CPPv315release_pointerP16ArrowArrayStream"></span><span
id="_CPPv215release_pointerP16ArrowArrayStream"></span><span
id="release_pointer__ArrowArrayStreamP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga41e68b38c2836cbb96e1610c1adc6a22"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="kt"><span class="pre">void</span></span><spa [...]
+<span id="_CPPv315release_pointerP16ArrowArrayStream"></span><span
id="_CPPv215release_pointerP16ArrowArrayStream"></span><span
id="release_pointer__ArrowArrayStreamP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga41e68b38c2836cbb96e1610c1adc6a22"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="kt"><span class="pre">void</span></span><spa [...]
<dd></dd></dl>
<dl class="cpp function">
diff --git a/dev/genindex.html b/dev/genindex.html
index 939b826..b6a03d2 100644
--- a/dev/genindex.html
+++ b/dev/genindex.html
@@ -276,11 +276,44 @@
| <a href="#M"><strong>M</strong></a>
| <a href="#N"><strong>N</strong></a>
| <a href="#R"><strong>R</strong></a>
+ | <a href="#U"><strong>U</strong></a>
</div>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="c.html#c.ARROW_C_DATA_INTERFACE">ARROW_C_DATA_INTERFACE (C
macro)</a>
+</li>
+ <li><a href="c.html#c.ARROW_C_STREAM_INTERFACE">ARROW_C_STREAM_INTERFACE
(C macro)</a>
+</li>
+ <li><a
href="c.html#c.ARROW_FLAG_DICTIONARY_ORDERED">ARROW_FLAG_DICTIONARY_ORDERED (C
macro)</a>
+</li>
+ <li><a
href="c.html#c.ARROW_FLAG_MAP_KEYS_SORTED">ARROW_FLAG_MAP_KEYS_SORTED (C
macro)</a>
+</li>
+ <li><a href="c.html#c.ARROW_FLAG_NULLABLE">ARROW_FLAG_NULLABLE (C
macro)</a>
+</li>
+ <li><a href="c.html#_CPPv410ArrowArray">ArrowArray (C++ struct)</a>
+</li>
+ <li><a href="c.html#_CPPv4N10ArrowArray7buffersE">ArrowArray::buffers
(C++ member)</a>
+</li>
+ <li><a href="c.html#_CPPv4N10ArrowArray8childrenE">ArrowArray::children
(C++ member)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N10ArrowArray10dictionaryE">ArrowArray::dictionary (C++
member)</a>
+</li>
+ <li><a href="c.html#_CPPv4N10ArrowArray6lengthE">ArrowArray::length (C++
member)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N10ArrowArray9n_buffersE">ArrowArray::n_buffers (C++
member)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N10ArrowArray10n_childrenE">ArrowArray::n_children (C++
member)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N10ArrowArray10null_countE">ArrowArray::null_count (C++
member)</a>
+</li>
+ <li><a href="c.html#_CPPv4N10ArrowArray6offsetE">ArrowArray::offset (C++
member)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N10ArrowArray12private_dataE">ArrowArray::private_data (C++
member)</a>
+</li>
+ <li><a href="c.html#_CPPv4N10ArrowArray7releaseE">ArrowArray::release
(C++ member)</a>
+</li>
<li><a
href="c.html#_CPPv426ArrowArrayAllocateChildrenP10ArrowArray7int64_t">ArrowArrayAllocateChildren
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv428ArrowArrayAllocateDictionaryP10ArrowArray">ArrowArrayAllocateDictionary
(C++ function)</a>
@@ -316,6 +349,18 @@
<li><a
href="c.html#_CPPv421ArrowArrayShrinkToFitP10ArrowArray">ArrowArrayShrinkToFit
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv424ArrowArrayStartAppendingP10ArrowArray">ArrowArrayStartAppending
(C++ function)</a>
+</li>
+ <li><a href="c.html#_CPPv416ArrowArrayStream">ArrowArrayStream (C++
struct)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N16ArrowArrayStream14get_last_errorE">ArrowArrayStream::get_last_error
(C++ member)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N16ArrowArrayStream8get_nextE">ArrowArrayStream::get_next
(C++ member)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N16ArrowArrayStream10get_schemaE">ArrowArrayStream::get_schema
(C++ member)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N16ArrowArrayStream12private_dataE">ArrowArrayStream::private_data
(C++ member)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N16ArrowArrayStream7releaseE">ArrowArrayStream::release (C++
member)</a>
</li>
<li><a
href="c.html#_CPPv424ArrowArrayValidityBitmapP10ArrowArray">ArrowArrayValidityBitmap
(C++ function)</a>
</li>
@@ -467,6 +512,8 @@
</li>
<li><a href="c.html#_CPPv415ArrowBufferView">ArrowBufferView (C++
struct)</a>
</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="c.html#_CPPv4N15ArrowBufferView4dataE">ArrowBufferView::data (C++
member)</a>
</li>
<li><a
href="c.html#_CPPv4N15ArrowBufferView7n_bytesE">ArrowBufferView::n_bytes (C++
member)</a>
@@ -479,8 +526,6 @@
</li>
<li><a href="c.html#_CPPv414ArrowErrorCode">ArrowErrorCode (C++ type)</a>
</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="c.html#_CPPv417ArrowErrorMessageP10ArrowError">ArrowErrorMessage (C++
function)</a>
</li>
<li><a
href="c.html#_CPPv413ArrowErrorSetP10ArrowErrorPKcz">ArrowErrorSet (C++
function)</a>
@@ -528,6 +573,26 @@
<li><a
href="c.html#_CPPv421ArrowNanoarrowBuildIdv">ArrowNanoarrowBuildId (C++
function)</a>
</li>
<li><a href="c.html#_CPPv412ArrowReallocPv7int64_t">ArrowRealloc (C++
function)</a>
+</li>
+ <li><a href="c.html#_CPPv411ArrowSchema">ArrowSchema (C++ struct)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N11ArrowSchema8childrenE">ArrowSchema::children (C++
member)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N11ArrowSchema10dictionaryE">ArrowSchema::dictionary (C++
member)</a>
+</li>
+ <li><a href="c.html#_CPPv4N11ArrowSchema5flagsE">ArrowSchema::flags (C++
member)</a>
+</li>
+ <li><a href="c.html#_CPPv4N11ArrowSchema6formatE">ArrowSchema::format
(C++ member)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N11ArrowSchema8metadataE">ArrowSchema::metadata (C++
member)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N11ArrowSchema10n_childrenE">ArrowSchema::n_children (C++
member)</a>
+</li>
+ <li><a href="c.html#_CPPv4N11ArrowSchema4nameE">ArrowSchema::name (C++
member)</a>
+</li>
+ <li><a
href="c.html#_CPPv4N11ArrowSchema12private_dataE">ArrowSchema::private_data
(C++ member)</a>
+</li>
+ <li><a href="c.html#_CPPv4N11ArrowSchema7releaseE">ArrowSchema::release
(C++ member)</a>
</li>
<li><a
href="c.html#_CPPv427ArrowSchemaAllocateChildrenP11ArrowSchema7int64_t">ArrowSchemaAllocateChildren
(C++ function)</a>
</li>
@@ -740,6 +805,26 @@
</ul></td>
</tr></table>
+<h2 id="U">U</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="cpp.html#_CPPv411UniqueArray">UniqueArray (C++ type)</a>
+</li>
+ <li><a href="cpp.html#_CPPv417UniqueArrayStream">UniqueArrayStream (C++
type)</a>
+</li>
+ <li><a href="cpp.html#_CPPv415UniqueArrayView">UniqueArrayView (C++
type)</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="cpp.html#_CPPv412UniqueBitmap">UniqueBitmap (C++ type)</a>
+</li>
+ <li><a href="cpp.html#_CPPv412UniqueBuffer">UniqueBuffer (C++ type)</a>
+</li>
+ <li><a href="cpp.html#_CPPv412UniqueSchema">UniqueSchema (C++ type)</a>
+</li>
+ </ul></td>
+</tr></table>
+
</article>
diff --git a/dev/objects.inv b/dev/objects.inv
index 5b8ee5d..2b3c6c6 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 00b76ef..8addfc7 100644
--- a/dev/r/pkgdown.yml
+++ b/dev/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.14.2
pkgdown: 2.0.6
pkgdown_sha: ~
articles: {}
-last_built: 2022-10-25T15:23Z
+last_built: 2022-10-25T18:56Z
diff --git a/dev/r/reference/as_nanoarrow_array.html
b/dev/r/reference/as_nanoarrow_array.html
index 96ed09f..e8fa03f 100644
--- a/dev/r/reference/as_nanoarrow_array.html
+++ b/dev/r/reference/as_nanoarrow_array.html
@@ -97,7 +97,7 @@ type. Defaults to <code><a
href="as_nanoarrow_schema.html">infer_nanoarrow_schem
<span class="r-out co"><span class="r-pr">#></span> $ offset : int
0</span>
<span class="r-out co"><span class="r-pr">#></span> $ buffers :List of
2</span>
<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_validity[0 b] at (nil)></span>
-<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x56525d0a7fa8></span>
+<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55d40513c798></span>
<span class="r-out co"><span class="r-pr">#></span> $ dictionary:
NULL</span>
<span class="r-out co"><span class="r-pr">#></span> $ children :
list()</span>
<span class="r-in"><span><span class="fu"><a
href="https://rdrr.io/r/base/vector.html"
class="external-link">as.vector</a></span><span class="op">(</span><span
class="va">array</span><span class="op">)</span></span></span>
@@ -117,7 +117,7 @@ type. Defaults to <code><a
href="as_nanoarrow_schema.html">infer_nanoarrow_schem
<span class="r-out co"><span class="r-pr">#></span> .. ..$ offset :
int 0</span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ buffers
:List of 2</span>
<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_validity[0 b] at (nil)></span>
-<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x56525ca27668></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55d404aad968></span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ dictionary:
NULL</span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ children :
list()</span>
<span class="r-out co"><span class="r-pr">#></span> $ dictionary:
NULL</span>
diff --git a/dev/r/reference/as_nanoarrow_array_stream.html
b/dev/r/reference/as_nanoarrow_array_stream.html
index 8fa7a91..c05c0cb 100644
--- a/dev/r/reference/as_nanoarrow_array_stream.html
+++ b/dev/r/reference/as_nanoarrow_array_stream.html
@@ -134,7 +134,7 @@ type. Defaults to <code><a
href="as_nanoarrow_schema.html">infer_nanoarrow_schem
<span class="r-out co"><span class="r-pr">#></span> .. ..$ offset :
int 0</span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ buffers
:List of 2</span>
<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_validity[0 b] at (nil)></span>
-<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x56525c3fc678></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55d4031a1738></span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ dictionary:
NULL</span>
<span class="r-out co"><span class="r-pr">#></span> .. ..$ children :
list()</span>
<span class="r-out co"><span class="r-pr">#></span> $ dictionary:
NULL</span>
diff --git a/dev/r/reference/nanoarrow_build_id.html
b/dev/r/reference/nanoarrow_build_id.html
index b5bf5cf..3a3308f 100644
--- a/dev/r/reference/nanoarrow_build_id.html
+++ b/dev/r/reference/nanoarrow_build_id.html
@@ -69,7 +69,7 @@ was compiled against.</p>
<div class="section level2">
<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor"
href="#ref-examples"></a></h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span
class="r-in"><span><span class="fu">nanoarrow_build_id</span><span
class="op">(</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#></span> [1] "VwfOwJKJwX"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "VkeUnGLEGl"</span>
<span class="r-in"><span></span></span>
</code></pre></div>
</div>
diff --git a/dev/r/search.json b/dev/r/search.json
index b20b258..87113e2 100644
--- a/dev/r/search.json
+++ b/dev/r/search.json
@@ -1 +1 @@
-[{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"Apache
License","title":"Apache License","text":"Version 2.0, January 2004
<http://www.apache.org/licenses/>","code":""},{"path":[]},{"path":"/LICENSE.html","id":"1-definitions","dir":"","previous_headings":"Terms
and Conditions for use, reproduction, and distribution","what":"1.
Definitions","title":"Apache License","text":"“License” shall mean terms
conditions use, reproduction, distribution defined Sections 1 9 [...]
+[{"path":"/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"Apache
License","title":"Apache License","text":"Version 2.0, January 2004
<http://www.apache.org/licenses/>","code":""},{"path":[]},{"path":"/LICENSE.html","id":"1-definitions","dir":"","previous_headings":"Terms
and Conditions for use, reproduction, and distribution","what":"1.
Definitions","title":"Apache License","text":"“License” shall mean terms
conditions use, reproduction, distribution defined Sections 1 9 [...]
diff --git a/dev/searchindex.js b/dev/searchindex.js
index 75fc8ec..ce8a241 100644
--- a/dev/searchindex.js
+++ b/dev/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["c", "cpp", "index"], "filenames": ["c.rst",
"cpp.rst", "index.rst"], "titles": ["C API Reference", "C++ API Reference",
"nanoarrow"], "terms": {"group": [0, 1], "nanoarrow": [0, 1], "except": 0,
"where": [0, 2], "note": 0, "object": [0, 2], "ar": [0, 1], "thread": 0,
"safe": 0, "client": [0, 2], "should": [0, 2], "take": [0, 1], "care": 0,
"serial": 0, "access": [0, 1], "method": [0, 1], "becaus": 0, "thi": [0, 1, 2],
"librari": [0, 1], "i": [0, 1, 2], "int [...]
\ No newline at end of file
+Search.setIndex({"docnames": ["c", "cpp", "index"], "filenames": ["c.rst",
"cpp.rst", "index.rst"], "titles": ["C API Reference", "C++ API Reference",
"nanoarrow"], "terms": {"group": [0, 1], "nanoarrow": [0, 1], "except": 0,
"where": [0, 2], "note": 0, "object": [0, 2], "ar": [0, 1], "thread": 0,
"safe": 0, "client": [0, 2], "should": [0, 2], "take": [0, 1], "care": 0,
"serial": 0, "access": [0, 1], "method": [0, 1], "becaus": 0, "thi": [0, 1, 2],
"librari": [0, 1], "i": [0, 1, 2], "int [...]
\ No newline at end of file