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 206d14c update documentation for tag dev
206d14c is described below
commit 206d14c949075dcc83b67871d638d8cb30213ce9
Author: GitHub Actions <[email protected]>
AuthorDate: Tue Oct 25 00:08:17 2022 +0000
update documentation for tag dev
---
dev/_sources/c.rst.txt | 2 +
dev/_sources/{index.rst.txt => cpp.rst.txt} | 23 +-
dev/_sources/index.rst.txt | 1 +
dev/c.html | 29 ++
dev/cpp.html | 627 +++++++++++++++++++++++++
dev/genindex.html | 63 ++-
dev/index.html | 20 +
dev/objects.inv | Bin 8856 -> 10166 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/search.html | 14 +
dev/searchindex.js | 2 +-
15 files changed, 779 insertions(+), 14 deletions(-)
diff --git a/dev/_sources/c.rst.txt b/dev/_sources/c.rst.txt
index 9bed1c8..352d0e9 100644
--- a/dev/_sources/c.rst.txt
+++ b/dev/_sources/c.rst.txt
@@ -18,6 +18,8 @@
C API Reference
==================
+.. doxygengroup:: nanoarrow
+
Creating schemas
------------------
.. doxygengroup:: nanoarrow-schema
diff --git a/dev/_sources/index.rst.txt b/dev/_sources/cpp.rst.txt
similarity index 67%
copy from dev/_sources/index.rst.txt
copy to dev/_sources/cpp.rst.txt
index 567d0e9..44b7b4e 100644
--- a/dev/_sources/index.rst.txt
+++ b/dev/_sources/cpp.rst.txt
@@ -15,12 +15,23 @@
.. specific language governing permissions and limitations
.. under the License.
-.. include:: README_generated.rst
+C++ API Reference
+==================
-Contents
---------
+.. doxygengroup:: nanoarrow_hpp
-.. toctree::
- :maxdepth: 2
+Owning object wrappers
+----------------------
+.. doxygengroup:: nanoarrow_hpp-unique
+ :members:
- C API Reference <c>
+Array Stream utilities
+----------------------
+
+.. doxygengroup:: nanoarrow_hpp-array-stream
+ :members:
+
+Base classes and utilities
+--------------------------
+.. doxygengroup:: nanoarrow_hpp-unique_base
+ :members:
diff --git a/dev/_sources/index.rst.txt b/dev/_sources/index.rst.txt
index 567d0e9..747e97a 100644
--- a/dev/_sources/index.rst.txt
+++ b/dev/_sources/index.rst.txt
@@ -24,3 +24,4 @@ Contents
:maxdepth: 2
C API Reference <c>
+ C++ API Reference <cpp>
diff --git a/dev/c.html b/dev/c.html
index 4dbbc32..453e1a7 100644
--- a/dev/c.html
+++ b/dev/c.html
@@ -40,6 +40,7 @@
<script>DOCUMENTATION_OPTIONS.pagename = 'c';</script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="C++ API Reference" href="cpp.html" />
<link rel="prev" title="nanoarrow" href="index.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
@@ -116,6 +117,13 @@
</li>
+ <li class="nav-item">
+ <a class="nav-link" href="cpp.html">
+ C++ API Reference
+ </a>
+ </li>
+
+
<li class="nav-item">
<a class="nav-link nav-external" href="r/index.html">R
Package<i class="fa-solid fa-up-right-from-square"></i></a>
</li>
@@ -192,6 +200,13 @@
</li>
+ <li class="nav-item">
+ <a class="nav-link" href="cpp.html">
+ C++ API Reference
+ </a>
+ </li>
+
+
<li class="nav-item">
<a class="nav-link nav-external" href="r/index.html">R
Package<i class="fa-solid fa-up-right-from-square"></i></a>
</li>
@@ -257,6 +272,13 @@
<section id="c-api-reference">
<h1>C API Reference<a class="headerlink" href="#c-api-reference"
title="Permalink to this heading">#</a></h1>
+<dl>
+<dt class="sig sig-object cpp">
+<span class="target" id="group__nanoarrow"></span><em><span
class="pre">group</span></em> <span class="sig-name descname"><span
class="pre">nanoarrow</span></span></dt>
+<dd><p>Except where noted, objects are not thread-safe and clients should take
care to serialize accesses to methods. </p>
+<p>Because this library is intended to be vendored, it provides full type
definitions and encourages clients to stack or statically allocate where
convenient. </p>
+</dd></dl>
+
<section id="creating-schemas">
<h2>Creating schemas<a class="headerlink" href="#creating-schemas"
title="Permalink to this heading">#</a></h2>
<dl>
@@ -1697,6 +1719,13 @@
<p class="prev-next-title">nanoarrow</p>
</div>
</a>
+ <a class='right-next' id="next-link" href="cpp.html" title="next page">
+ <div class="prev-next-info">
+ <p class="prev-next-subtitle">next</p>
+ <p class="prev-next-title">C++ API Reference</p>
+ </div>
+ <i class="fa-solid fa-angle-right"></i>
+ </a>
</div>
</footer>
diff --git a/dev/cpp.html b/dev/cpp.html
new file mode 100644
index 0000000..84bbfe3
--- /dev/null
+++ b/dev/cpp.html
@@ -0,0 +1,627 @@
+
+<!DOCTYPE html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0"
/><meta name="generator" content="Docutils 0.19:
https://docutils.sourceforge.io/" />
+
+ <title>C++ API Reference — nanoarrow documentation</title>
+ <script>
+ document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
+ document.documentElement.dataset.theme = localStorage.getItem("theme") ||
"light";
+ </script>
+
+ <!-- Loaded before other Sphinx assets -->
+ <link href="_static/styles/theme.css?digest=1e1de1a1873e13ef5536"
rel="stylesheet">
+<link
href="_static/styles/pydata-sphinx-theme.css?digest=1e1de1a1873e13ef5536"
rel="stylesheet">
+
+
+ <link rel="stylesheet"
+ href="_static/vendor/fontawesome/6.1.2/css/all.min.css">
+ <link rel="preload" as="font" type="font/woff2" crossorigin
+ href="_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2">
+ <link rel="preload" as="font" type="font/woff2" crossorigin
+ href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2">
+ <link rel="preload" as="font" type="font/woff2" crossorigin
+ href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2">
+
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+
+ <!-- Pre-loaded scripts that we'll load fully later -->
+ <link rel="preload" as="script"
href="_static/scripts/pydata-sphinx-theme.js?digest=1e1de1a1873e13ef5536">
+
+ <script data-url_root="./" id="documentation_options"
src="_static/documentation_options.js"></script>
+ <script src="_static/jquery.js"></script>
+ <script src="_static/underscore.js"></script>
+ <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
+ <script src="_static/doctools.js"></script>
+ <script src="_static/sphinx_highlight.js"></script>
+ <script>DOCUMENTATION_OPTIONS.pagename = 'cpp';</script>
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="prev" title="C API Reference" href="c.html" />
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
+ <meta name="docsearch:language" content="en">
+ </head>
+
+
+ <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="180"
data-default-mode="">
+
+
+ <input type="checkbox" class="sidebar-toggle" name="__primary"
id="__primary">
+ <label class="overlay overlay-primary" for="__primary"></label>
+
+
+ <input type="checkbox" class="sidebar-toggle" name="__secondary"
id="__secondary">
+ <label class="overlay overlay-secondary" for="__secondary"></label>
+
+
+ <div class="search-button__wrapper">
+ <div class="search-button__overlay"></div>
+ <div class="search-button__search-container">
+
+<form class="bd-search d-flex align-items-center" action="search.html"
method="get">
+ <i class="fa-solid fa-magnifying-glass"></i>
+ <input type="search" class="form-control" name="q" id="search-input"
placeholder="Search the docs ..." aria-label="Search the docs ..."
autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false">
+ <span class="search-button__kbd-shortcut"><kbd
class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
+</form>
+ </div>
+ </div>
+
+
+ <nav class="bd-header navbar navbar-expand-lg bd-navbar"
id="navbar-main"><div class="bd-header__inner bd-page-width">
+ <label class="sidebar-toggle primary-toggle" for="__primary">
+ <span class="fa-solid fa-bars"></span>
+ </label>
+ <div id="navbar-start">
+
+
+
+
+
+<a class="navbar-brand logo" href="index.html">
+
+
+
+
+
+
+
+
+
+
+
+ <p class="title logo__title">nanoarrow documentation</p>
+
+</a>
+
+ </div>
+
+
+ <div class="col-lg-9 navbar-header-items">
+ <div id="navbar-center" class="mr-auto">
+
+ <div class="navbar-center-item">
+ <nav class="navbar-nav">
+ <p class="sidebar-header-items__title" role="heading" aria-level="1"
aria-label="Site Navigation">
+ Site Navigation
+ </p>
+ <ul id="navbar-main-elements" class="navbar-nav">
+
+ <li class="nav-item">
+ <a class="nav-link" href="c.html">
+ C API Reference
+ </a>
+ </li>
+
+
+ <li class="nav-item current active">
+ <a class="nav-link" href="#">
+ C++ API Reference
+ </a>
+ </li>
+
+
+ <li class="nav-item">
+ <a class="nav-link nav-external" href="r/index.html">R
Package<i class="fa-solid fa-up-right-from-square"></i></a>
+ </li>
+ </ul>
+</nav>
+ </div>
+
+ </div>
+
+ <div id="navbar-end">
+ <div class="navbar-end-item navbar-end__search-button-container">
+
+<button class="btn btn-sm navbar-btn search-button search-button__button"
title="Search" data-toggle="tooltip">
+ <i class="fa-solid fa-magnifying-glass"></i>
+</button>
+ </div>
+
+ <div class="navbar-end-item">
+ <span class="theme-switch-button btn btn-sm btn-outline-primary
navbar-btn rounded-circle" title="light/dark" data-toggle="tooltip">
+ <a class="theme-switch" data-mode="light"><i class="fa-solid
fa-sun"></i></a>
+ <a class="theme-switch" data-mode="dark"><i class="fa-regular
fa-moon"></i></a>
+ <a class="theme-switch" data-mode="auto"><i class="fa-solid
fa-circle-half-stroke"></i></a>
+</span>
+ </div>
+
+ <div class="navbar-end-item">
+ <ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
+ </ul>
+ </div>
+
+ </div>
+ </div>
+
+
+
+ <div class="search-button-container--mobile">
+<button class="btn btn-sm navbar-btn search-button search-button__button"
title="Search" data-toggle="tooltip">
+ <i class="fa-solid fa-magnifying-glass"></i>
+</button>
+ </div>
+
+
+ <label class="sidebar-toggle secondary-toggle" for="__secondary">
+ <span class="fa-solid fa-outdent"></span>
+ </label>
+
+
+</div>
+ </nav>
+
+
+ <div class="bd-container">
+ <div class="bd-container__inner bd-page-width">
+
+ <div class="bd-sidebar-primary bd-sidebar">
+
+
+ <div class="sidebar-header-items sidebar-primary__section">
+
+
+ <div class="sidebar-header-items__center">
+
+ <div class="navbar-center-item">
+ <nav class="navbar-nav">
+ <p class="sidebar-header-items__title" role="heading" aria-level="1"
aria-label="Site Navigation">
+ Site Navigation
+ </p>
+ <ul id="navbar-main-elements" class="navbar-nav">
+
+ <li class="nav-item">
+ <a class="nav-link" href="c.html">
+ C API Reference
+ </a>
+ </li>
+
+
+ <li class="nav-item current active">
+ <a class="nav-link" href="#">
+ C++ API Reference
+ </a>
+ </li>
+
+
+ <li class="nav-item">
+ <a class="nav-link nav-external" href="r/index.html">R
Package<i class="fa-solid fa-up-right-from-square"></i></a>
+ </li>
+ </ul>
+</nav>
+ </div>
+
+ </div>
+
+
+
+
+ <div class="sidebar-header-items__end">
+
+ <div class="navbar-end-item">
+ <span class="theme-switch-button btn btn-sm btn-outline-primary
navbar-btn rounded-circle" title="light/dark" data-toggle="tooltip">
+ <a class="theme-switch" data-mode="light"><i class="fa-solid
fa-sun"></i></a>
+ <a class="theme-switch" data-mode="dark"><i class="fa-regular
fa-moon"></i></a>
+ <a class="theme-switch" data-mode="auto"><i class="fa-solid
fa-circle-half-stroke"></i></a>
+</span>
+ </div>
+
+ <div class="navbar-end-item">
+ <ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
+ </ul>
+ </div>
+
+ </div>
+
+ </div>
+
+
+ <div class="sidebar-start-items sidebar-primary__section">
+ <div class="sidebar-start-items__item">
+<form class="bd-search d-flex align-items-center" action="search.html"
method="get">
+ <i class="fa-solid fa-magnifying-glass"></i>
+ <input type="search" class="form-control" name="q" id="search-input"
placeholder="Search the docs ..." aria-label="Search the docs ..."
autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false">
+ <span class="search-button__kbd-shortcut"><kbd
class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
+</form>
+ </div>
+ </div>
+
+
+
+ <div class="sidebar-end-items sidebar-primary__section">
+ <div class="sidebar-end-items__item">
+ </div>
+ </div>
+
+ </div>
+ <main class="bd-main">
+
+
+ <div class="bd-content">
+ <div class="bd-article-container">
+
+ <div class="bd-header-article">
+
+ </div>
+
+
+ <article class="bd-article" role="main">
+
+ <section id="c-api-reference">
+<h1>C++ API Reference<a class="headerlink" href="#c-api-reference"
title="Permalink to this heading">#</a></h1>
+<dl>
+<dt class="sig sig-object cpp">
+<span class="target" id="group__nanoarrow__hpp"></span><em><span
class="pre">group</span></em> <span class="sig-name descname"><span
class="pre">nanoarrow_hpp</span></span></dt>
+<dd><p>The utilities provided in this file are intended to support C++ users
of the nanoarrow C library such that C++-style resource allocation and error
handling can be used with nanoarrow data structures. These utilities are not
intended to mirror the nanoarrow C API. </p>
+</dd></dl>
+
+<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>
+</div>
+</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>
+<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>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>
+<p>This object takes ownership of the schema and marks the source schema as
released. </p>
+</dd></dl>
+
+</div>
+</dd></dl>
+
+<dl class="cpp class">
+<dt class="sig sig-object cpp" id="_CPPv4N9nanoarrow17VectorArrayStreamE">
+<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>
+<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 [...]
+<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"> [...]
+<dd><p>Create a UniqueArrowArrayStream from existing arrays. </p>
+<p>This object takes ownership of the schema and arrays. </p>
+</dd></dl>
+
+</div>
+</dd></dl>
+
+</dd></dl>
+
+</section>
+<section id="base-classes-and-utilities">
+<h2>Base classes and utilities<a class="headerlink"
href="#base-classes-and-utilities" title="Permalink to this heading">#</a></h2>
+<dl>
+<dt class="sig sig-object cpp">
+<span class="target" id="group__nanoarrow__hpp-unique__base"></span><em><span
class="pre">group</span></em> <span class="sig-name descname"><span
class="pre">nanoarrow_hpp-unique_base</span></span></dt>
+<dd><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="_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
[...]
+<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< [...]
+<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"> </ [...]
+<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
[...]
+<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> [...]
+<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 [...]
+<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=" [...]
+<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 [...]
+<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 [...]
+<dd></dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv412init_pointerP11ArrowBuffer">
+<span id="_CPPv312init_pointerP11ArrowBuffer"></span><span
id="_CPPv212init_pointerP11ArrowBuffer"></span><span
id="init_pointer__ArrowBufferP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga1ab1e6cd29eea84565ca8aa5418a566b"></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_pointerP11ArrowBufferP11ArrowBuffer">
+<span id="_CPPv312move_pointerP11ArrowBufferP11ArrowBuffer"></span><span
id="_CPPv212move_pointerP11ArrowBufferP11ArrowBuffer"></span><span
id="move_pointer__ArrowBufferP.ArrowBufferP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1gaeeb83d7db1e27fc677ed3f5d8d6b473b"></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_pointerP11ArrowBuffer">
+<span id="_CPPv315release_pointerP11ArrowBuffer"></span><span
id="_CPPv215release_pointerP11ArrowBuffer"></span><span
id="release_pointer__ArrowBufferP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga748ba2bfaaeb5549655512989b1d74fd"></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_pointerP11ArrowBitmap">
+<span id="_CPPv312init_pointerP11ArrowBitmap"></span><span
id="_CPPv212init_pointerP11ArrowBitmap"></span><span
id="init_pointer__ArrowBitmapP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1gaf95f898990fafeecb5353028f17810fd"></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_pointerP11ArrowBitmapP11ArrowBitmap">
+<span id="_CPPv312move_pointerP11ArrowBitmapP11ArrowBitmap"></span><span
id="_CPPv212move_pointerP11ArrowBitmapP11ArrowBitmap"></span><span
id="move_pointer__ArrowBitmapP.ArrowBitmapP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga725860c9de0ace4de99af63a724eeac3"></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_pointerP11ArrowBitmap">
+<span id="_CPPv315release_pointerP11ArrowBitmap"></span><span
id="_CPPv215release_pointerP11ArrowBitmap"></span><span
id="release_pointer__ArrowBitmapP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga1baf23f447836e06300cc77225af88b1"></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_pointerP14ArrowArrayView">
+<span id="_CPPv312init_pointerP14ArrowArrayView"></span><span
id="_CPPv212init_pointerP14ArrowArrayView"></span><span
id="init_pointer__ArrowArrayViewP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1gaf1154790a4a0402506faf6cdf5df42db"></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="_CPPv412move_pointerP14ArrowArrayViewP14ArrowArrayView">
+<span id="_CPPv312move_pointerP14ArrowArrayViewP14ArrowArrayView"></span><span
id="_CPPv212move_pointerP14ArrowArrayViewP14ArrowArrayView"></span><span
id="move_pointer__ArrowArrayViewP.ArrowArrayViewP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga9211cbe1dcf411822220acb7955703cd"></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 [...]
+<dd></dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv415release_pointerP14ArrowArrayView">
+<span id="_CPPv315release_pointerP14ArrowArrayView"></span><span
id="_CPPv215release_pointerP14ArrowArrayView"></span><span
id="release_pointer__ArrowArrayViewP"></span><span class="target"
id="group__nanoarrow__hpp-unique__base_1ga80b7e180e5d2f661427efc290e60e0f1"></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 clas [...]
+<dd></dd></dl>
+
+</div>
+<dl class="cpp class">
+<dt class="sig sig-object cpp" id="_CPPv4I0EN9nanoarrow8internal6UniqueE">
+<span id="_CPPv3I0EN9nanoarrow8internal6UniqueE"></span><span
id="_CPPv2I0EN9nanoarrow8internal6UniqueE"></span><span class="k"><span
class="pre">template</span></span><span class="p"><span
class="pre"><</span></span><span class="k"><span
class="pre">typename</span></span><span class="w"> </span><span class="sig-name
descname"><span class="n"><span class="pre">T</span></span></span><span
class="p"><span class="pre">></span></span><br /><span class="target"
id="classnanoarrow_1_1int [...]
+<dd><div class="docutils container">
+<em>#include <nanoarrow.hpp></em></div>
+<p>A unique_ptr-like base class for stack-allocatable objects. </p>
+<dl class="field-list simple">
+<dt class="field-odd">Template Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>T</strong> – The object type </p>
+</dd>
+</dl>
+<div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric"
id="breathe-section-title-public-functions">Public Functions</p>
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N9nanoarrow8internal6Unique6UniqueEv">
+<span id="_CPPv3N9nanoarrow8internal6Unique6UniqueEv"></span><span
id="_CPPv2N9nanoarrow8internal6Unique6UniqueEv"></span><span
id="nanoarrow::internal::Unique::Unique"></span><span class="target"
id="classnanoarrow_1_1internal_1_1_unique_1a004ae4a4a8deaaca56f73d33b13318da"></span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">Unique</span></span></span><span class="sig-paren">(</span><span c
[...]
+<dd><p>Construct an invalid instance of T holding no resources. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv4N9nanoarrow8internal6Unique6UniqueEP1T">
+<span id="_CPPv3N9nanoarrow8internal6Unique6UniqueEP1T"></span><span
id="_CPPv2N9nanoarrow8internal6Unique6UniqueEP1T"></span><span
id="nanoarrow::internal::Unique::Unique__TP"></span><span class="target"
id="classnanoarrow_1_1internal_1_1_unique_1a6903dc88ef1791497cfbe9c63ef974ca"></span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">Unique</span></span></span><span class="sig-paren">(</span [...]
+<dd><p>Move and take ownership of data. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv4N9nanoarrow8internal6Unique6UniqueERR6Unique">
+<span id="_CPPv3N9nanoarrow8internal6Unique6UniqueERR6Unique"></span><span
id="_CPPv2N9nanoarrow8internal6Unique6UniqueERR6Unique"></span><span
id="nanoarrow::internal::Unique::Unique__UniqueRR"></span><span class="target"
id="classnanoarrow_1_1internal_1_1_unique_1a8bd291672a60ebf756a1ef6eca9240b6"></span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><span
class="sig-name descname"><span class="n"><span
class="pre">Unique</span></span></span><span class=" [...]
+<dd><p>Move and take ownership of data wrapped by rhs. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N9nanoarrow8internal6Unique3getEv">
+<span id="_CPPv3N9nanoarrow8internal6Unique3getEv"></span><span
id="_CPPv2N9nanoarrow8internal6Unique3getEv"></span><span
id="nanoarrow::internal::Unique::get"></span><span class="target"
id="classnanoarrow_1_1internal_1_1_unique_1ae3a985823191b160cb83b84b4a7e2464"></span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv4I0EN9nanoarrow8internal6UniqueE"
title="nanoarrow::internal::Unique::T"><span class="n"><span clas [...]
+<dd><p>Get a pointer to the data owned by this object. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N9nanoarrow8internal6UniqueptEv">
+<span id="_CPPv3N9nanoarrow8internal6UniqueptEv"></span><span
id="_CPPv2N9nanoarrow8internal6UniqueptEv"></span><span
id="nanoarrow::internal::Unique::pointer-operator"></span><span class="target"
id="classnanoarrow_1_1internal_1_1_unique_1a94c70b2e6027be26c1c33edc50bfad77"></span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv4I0EN9nanoarrow8internal6UniqueE"
title="nanoarrow::internal::Unique::T"><span class="n">< [...]
+<dd><p>Use the pointer operator to access fields of this object. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N9nanoarrow8internal6Unique5resetEv">
+<span id="_CPPv3N9nanoarrow8internal6Unique5resetEv"></span><span
id="_CPPv2N9nanoarrow8internal6Unique5resetEv"></span><span
id="nanoarrow::internal::Unique::reset"></span><span class="target"
id="classnanoarrow_1_1internal_1_1_unique_1aa1f589b25d78be96d1d82bd52e9f78f7"></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
class="sig-name descname"><span class="n"><span clas [...]
+<dd><p>Call data’s release callback if valid. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv4N9nanoarrow8internal6Unique5resetEP1T">
+<span id="_CPPv3N9nanoarrow8internal6Unique5resetEP1T"></span><span
id="_CPPv2N9nanoarrow8internal6Unique5resetEP1T"></span><span
id="nanoarrow::internal::Unique::reset__TP"></span><span class="target"
id="classnanoarrow_1_1internal_1_1_unique_1a4fdcf72051df5b44b249d4916043057e"></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
class="sig-name descname"><span class="n"><s [...]
+<dd><p>Call data’s release callback if valid and move ownership of the data
pointed to by data. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N9nanoarrow8internal6Unique4moveEP1T">
+<span id="_CPPv3N9nanoarrow8internal6Unique4moveEP1T"></span><span
id="_CPPv2N9nanoarrow8internal6Unique4moveEP1T"></span><span
id="nanoarrow::internal::Unique::move__TP"></span><span class="target"
id="classnanoarrow_1_1internal_1_1_unique_1a38b63f427f4e78b3d14f8bb1c8ce6574"></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
class="sig-name descname"><span class="n"><span [...]
+<dd><p>Move ownership of this object to the data pointed to by out. </p>
+</dd></dl>
+
+</div>
+</dd></dl>
+
+</dd></dl>
+
+</section>
+</section>
+
+
+ </article>
+
+
+
+ <footer class="bd-footer-article">
+ <!-- Previous / next buttons -->
+<div class='prev-next-area'>
+ <a class='left-prev' id="prev-link" href="c.html" title="previous page">
+ <i class="fa-solid fa-angle-left"></i>
+ <div class="prev-next-info">
+ <p class="prev-next-subtitle">previous</p>
+ <p class="prev-next-title">C API Reference</p>
+ </div>
+ </a>
+</div>
+ </footer>
+
+ </div>
+
+
+
+ <div class="bd-sidebar-secondary bd-toc">
+
+<div class="toc-item">
+
+<div class="tocsection onthispage">
+ <i class="fa-solid fa-list"></i> On this page
+</div>
+<nav id="bd-toc-nav" class="page-toc">
+ <ul class="visible nav section-nav flex-column">
+ <li class="toc-h2 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#owning-object-wrappers">
+ Owning object wrappers
+ </a>
+ </li>
+ <li class="toc-h2 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#array-stream-utilities">
+ Array Stream utilities
+ </a>
+ </li>
+ <li class="toc-h2 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#base-classes-and-utilities">
+ Base classes and utilities
+ </a>
+ </li>
+</ul>
+
+</nav>
+</div>
+
+<div class="toc-item">
+
+<div id="searchbox"></div>
+</div>
+
+<div class="toc-item">
+
+
+<div class="tocsection editthispage">
+ <a
href="https://github.com/apache/arrow-nanoarrow/edit/main/docs/source/cpp.rst">
+ <i class="fa-solid fa-pencil"></i> Edit this page
+ </a>
+</div>
+
+</div>
+
+<div class="toc-item">
+
+<div class="tocsection sourcelink">
+ <a href="_sources/cpp.rst.txt">
+ <i class="fa-solid fa-file-lines"></i> Show Source
+ </a>
+</div>
+
+</div>
+
+ </div>
+
+
+ </div>
+ <footer class="bd-footer-content">
+ <div class="bd-footer-content__inner">
+
+ </div>
+ </footer>
+
+ </main>
+ </div>
+ </div>
+
+
+
+ <!-- Scripts loaded after <body> so the DOM is not blocked -->
+ <script
src="_static/scripts/pydata-sphinx-theme.js?digest=1e1de1a1873e13ef5536"></script>
+
+ <footer class="bd-footer"><div class="bd-footer__inner container">
+
+ <div class="footer-item">
+
+<p class="copyright">
+
+ © Copyright 2016-2022 Apache Software Foundation.<br>
+
+</p>
+
+ </div>
+
+ <div class="footer-item">
+
+<p class="sphinx-version">
+Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.3.0.<br>
+</p>
+
+ </div>
+
+</div>
+ </footer>
+ </body>
+</html>
\ No newline at end of file
diff --git a/dev/genindex.html b/dev/genindex.html
index a376a93..939b826 100644
--- a/dev/genindex.html
+++ b/dev/genindex.html
@@ -114,6 +114,13 @@
</li>
+ <li class="nav-item">
+ <a class="nav-link" href="cpp.html">
+ C++ API Reference
+ </a>
+ </li>
+
+
<li class="nav-item">
<a class="nav-link nav-external" href="r/index.html">R
Package<i class="fa-solid fa-up-right-from-square"></i></a>
</li>
@@ -190,6 +197,13 @@
</li>
+ <li class="nav-item">
+ <a class="nav-link" href="cpp.html">
+ C++ API Reference
+ </a>
+ </li>
+
+
<li class="nav-item">
<a class="nav-link nav-external" href="r/index.html">R
Package<i class="fa-solid fa-up-right-from-square"></i></a>
</li>
@@ -258,7 +272,10 @@
<div class="genindex-jumpbox">
<a href="#A"><strong>A</strong></a>
+ | <a href="#I"><strong>I</strong></a>
+ | <a href="#M"><strong>M</strong></a>
| <a href="#N"><strong>N</strong></a>
+ | <a href="#R"><strong>R</strong></a>
</div>
<h2 id="A">A</h2>
@@ -667,18 +684,62 @@
</ul></td>
</tr></table>
+<h2 id="I">I</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="cpp.html#_CPPv412init_pointerP10ArrowArray">init_pointer
(C++ function)</a>, <a
href="cpp.html#_CPPv412init_pointerP11ArrowBitmap">[1]</a>, <a
href="cpp.html#_CPPv412init_pointerP11ArrowBuffer">[2]</a>, <a
href="cpp.html#_CPPv412init_pointerP11ArrowSchema">[3]</a>, <a
href="cpp.html#_CPPv412init_pointerP14ArrowArrayView">[4]</a>, <a
href="cpp.html#_CPPv412init_pointerP16ArrowArrayStream">[5]</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="M">M</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a
href="cpp.html#_CPPv412move_pointerP10ArrowArrayP10ArrowArray">move_pointer
(C++ function)</a>, <a
href="cpp.html#_CPPv412move_pointerP11ArrowBitmapP11ArrowBitmap">[1]</a>, <a
href="cpp.html#_CPPv412move_pointerP11ArrowBufferP11ArrowBuffer">[2]</a>, <a
href="cpp.html#_CPPv412move_pointerP11ArrowSchemaP11ArrowSchema">[3]</a>, <a
href="cpp.html#_CPPv412move_pointerP14ArrowArrayViewP14ArrowArrayView">[4]</a>,
<a href="cpp.html#_CPPv412move_pointerP16ArrowArrayStreamP16ArrowArra [...]
+</li>
+ </ul></td>
+</tr></table>
+
<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
- <li><a href="c.html#c.NANOARROW_OK">NANOARROW_OK (C macro)</a>
+ <li><a
href="cpp.html#_CPPv4N9nanoarrow16EmptyArrayStreamE">nanoarrow::EmptyArrayStream
(C++ class)</a>
+</li>
+ <li><a
href="cpp.html#_CPPv4N9nanoarrow16EmptyArrayStream10MakeUniqueEP11ArrowSchema">nanoarrow::EmptyArrayStream::MakeUnique
(C++ function)</a>
+</li>
+ <li><a
href="cpp.html#_CPPv4I0EN9nanoarrow8internal6UniqueE">nanoarrow::internal::Unique
(C++ class)</a>
+</li>
+ <li><a
href="cpp.html#_CPPv4N9nanoarrow8internal6Unique3getEv">nanoarrow::internal::Unique::get
(C++ function)</a>
+</li>
+ <li><a
href="cpp.html#_CPPv4N9nanoarrow8internal6Unique4moveEP1T">nanoarrow::internal::Unique::move
(C++ function)</a>
+</li>
+ <li><a
href="cpp.html#_CPPv4N9nanoarrow8internal6UniqueptEv">nanoarrow::internal::Unique::operator->
(C++ function)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
+ <li><a
href="cpp.html#_CPPv4N9nanoarrow8internal6Unique5resetEP1T">nanoarrow::internal::Unique::reset
(C++ function)</a>, <a
href="cpp.html#_CPPv4N9nanoarrow8internal6Unique5resetEv">[1]</a>
+</li>
+ <li><a
href="cpp.html#_CPPv4N9nanoarrow8internal6Unique6UniqueEP1T">nanoarrow::internal::Unique::Unique
(C++ function)</a>, <a
href="cpp.html#_CPPv4N9nanoarrow8internal6Unique6UniqueERR6Unique">[1]</a>, <a
href="cpp.html#_CPPv4N9nanoarrow8internal6Unique6UniqueEv">[2]</a>
+</li>
+ <li><a
href="cpp.html#_CPPv4N9nanoarrow17VectorArrayStreamE">nanoarrow::VectorArrayStream
(C++ class)</a>
+</li>
+ <li><a
href="cpp.html#_CPPv4N9nanoarrow17VectorArrayStream10MakeUniqueEP11ArrowSchemaNSt6vectorI11UniqueArrayEE">nanoarrow::VectorArrayStream::MakeUnique
(C++ function)</a>, <a
href="cpp.html#_CPPv4N9nanoarrow17VectorArrayStream10MakeUniqueEP11ArrowSchemaP10ArrowArray">[1]</a>
+</li>
+ <li><a href="c.html#c.NANOARROW_OK">NANOARROW_OK (C macro)</a>
+</li>
<li><a href="c.html#c.NANOARROW_RETURN_NOT_OK">NANOARROW_RETURN_NOT_OK
(C macro)</a>
</li>
</ul></td>
</tr></table>
+<h2 id="R">R</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a
href="cpp.html#_CPPv415release_pointerP10ArrowArray">release_pointer (C++
function)</a>, <a
href="cpp.html#_CPPv415release_pointerP11ArrowBitmap">[1]</a>, <a
href="cpp.html#_CPPv415release_pointerP11ArrowBuffer">[2]</a>, <a
href="cpp.html#_CPPv415release_pointerP11ArrowSchema">[3]</a>, <a
href="cpp.html#_CPPv415release_pointerP14ArrowArrayView">[4]</a>, <a
href="cpp.html#_CPPv415release_pointerP16ArrowArrayStream">[5]</a>
+</li>
+ </ul></td>
+</tr></table>
+
</article>
diff --git a/dev/index.html b/dev/index.html
index 305b7fb..612f39b 100644
--- a/dev/index.html
+++ b/dev/index.html
@@ -116,6 +116,13 @@
</li>
+ <li class="nav-item">
+ <a class="nav-link" href="cpp.html">
+ C++ API Reference
+ </a>
+ </li>
+
+
<li class="nav-item">
<a class="nav-link nav-external" href="r/index.html">R
Package<i class="fa-solid fa-up-right-from-square"></i></a>
</li>
@@ -192,6 +199,13 @@
</li>
+ <li class="nav-item">
+ <a class="nav-link" href="cpp.html">
+ C++ API Reference
+ </a>
+ </li>
+
+
<li class="nav-item">
<a class="nav-link nav-external" href="r/index.html">R
Package<i class="fa-solid fa-up-right-from-square"></i></a>
</li>
@@ -364,6 +378,12 @@ repository.</p>
<li class="toctree-l2"><a class="reference internal"
href="c.html#arrow-c-data-interface">Arrow C Data Interface</a></li>
</ul>
</li>
+<li class="toctree-l1"><a class="reference internal" href="cpp.html">C++ API
Reference</a><ul>
+<li class="toctree-l2"><a class="reference internal"
href="cpp.html#owning-object-wrappers">Owning object wrappers</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="cpp.html#array-stream-utilities">Array Stream utilities</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="cpp.html#base-classes-and-utilities">Base classes and utilities</a></li>
+</ul>
+</li>
</ul>
</div>
</section>
diff --git a/dev/objects.inv b/dev/objects.inv
index 9a6cd8f..5b8ee5d 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 1a11226..79a28af 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-24T13:36Z
+last_built: 2022-10-25T00:08Z
diff --git a/dev/r/reference/as_nanoarrow_array.html
b/dev/r/reference/as_nanoarrow_array.html
index 141b28b..f51e217 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 0x564be8b490f8></span>
+<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x558978051978></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 0x564be85b8b58></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x5589779c06a8></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 1c86679..8a80c3f 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 0x564be7e4eff8></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55897712d558></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 3dd6cf8..3650e6a 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] "6jIuKh6IeP"</span>
+<span class="r-out co"><span class="r-pr">#></span> [1] "EiPwtixPYp"</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 29aa801..b55c4b3 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/search.html b/dev/search.html
index f04ffb4..91a33dd 100644
--- a/dev/search.html
+++ b/dev/search.html
@@ -116,6 +116,13 @@
</li>
+ <li class="nav-item">
+ <a class="nav-link" href="cpp.html">
+ C++ API Reference
+ </a>
+ </li>
+
+
<li class="nav-item">
<a class="nav-link nav-external" href="r/index.html">R
Package<i class="fa-solid fa-up-right-from-square"></i></a>
</li>
@@ -192,6 +199,13 @@
</li>
+ <li class="nav-item">
+ <a class="nav-link" href="cpp.html">
+ C++ API Reference
+ </a>
+ </li>
+
+
<li class="nav-item">
<a class="nav-link nav-external" href="r/index.html">R
Package<i class="fa-solid fa-up-right-from-square"></i></a>
</li>
diff --git a/dev/searchindex.js b/dev/searchindex.js
index e06c86a..75fc8ec 100644
--- a/dev/searchindex.js
+++ b/dev/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["c", "index"], "filenames": ["c.rst",
"index.rst"], "titles": ["C API Reference", "nanoarrow"], "terms": {"group": 0,
"nanoarrow": 0, "These": 0, "function": [0, 1], "alloc": 0, "copi": [0, 1],
"destroi": 0, "arrowschema": [0, 1], "arrowerrorcod": 0, "arrowschemainit": [0,
1], "struct": [0, 1], "enum": 0, "arrowtyp": 0, "type": 0, "initi": 0, "field":
0, "releas": [0, 1], "callback": 0, "schema_out": [0, 1], "caller": 0, "i": [0,
1], "respons": 0, "call": 0, [...]
\ 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