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 472f151 update documentation for tag dev
472f151 is described below
commit 472f151d3b42390a7fed9771aaea62004ac07498
Author: GitHub Actions <[email protected]>
AuthorDate: Fri Dec 2 19:00:55 2022 +0000
update documentation for tag dev
---
dev/c.html | 49 ++++++++++-
dev/genindex.html | 18 +++-
dev/objects.inv | Bin 11467 -> 11789 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/basic_array_stream.html | 114 +++++++++++++++++++++++++
dev/r/reference/index.html | 5 ++
dev/r/search.json | 2 +-
dev/r/sitemap.xml | 3 +
dev/searchindex.js | 2 +-
11 files changed, 192 insertions(+), 9 deletions(-)
diff --git a/dev/c.html b/dev/c.html
index 41a2d3a..054ca97 100644
--- a/dev/c.html
+++ b/dev/c.html
@@ -701,6 +701,13 @@
<dd><p>Initialize the contents of an <a class="reference internal"
href="#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a>. </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv418ArrowArrayViewMoveP14ArrowArrayViewP14ArrowArrayView">
+<span
id="_CPPv318ArrowArrayViewMoveP14ArrowArrayViewP14ArrowArrayView"></span><span
id="_CPPv218ArrowArrayViewMoveP14ArrowArrayViewP14ArrowArrayView"></span><span
id="ArrowArrayViewMove__ArrowArrayViewP.ArrowArrayViewP"></span><span
class="target"
id="group__nanoarrow-array-view_1ga1d0b313a8cdb5c58f548812bff4720f1"></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 [...]
+<dd><p>Move an <a class="reference internal"
href="#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a>. </p>
+<p>Transfers the <a class="reference internal"
href="#struct_arrow_array_view"><span class="std
std-ref">ArrowArrayView</span></a> data and lifecycle management to another
address and resets the contents of src. </p>
+</dd></dl>
+
<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 [...]
@@ -856,7 +863,7 @@
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv415ArrowBufferMoveP11ArrowBufferP11ArrowBuffer">
-<span id="_CPPv315ArrowBufferMoveP11ArrowBufferP11ArrowBuffer"></span><span
id="_CPPv215ArrowBufferMoveP11ArrowBufferP11ArrowBuffer"></span><span
id="ArrowBufferMove__ArrowBufferP.ArrowBufferP"></span><span class="target"
id="group__nanoarrow-buffer_1ga1c82fbbedca64d91977a03ca00818f6d"></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</s [...]
+<span id="_CPPv315ArrowBufferMoveP11ArrowBufferP11ArrowBuffer"></span><span
id="_CPPv215ArrowBufferMoveP11ArrowBufferP11ArrowBuffer"></span><span
id="ArrowBufferMove__ArrowBufferP.ArrowBufferP"></span><span class="target"
id="group__nanoarrow-buffer_1gab310f20fc31ebcf68fb09f286f5c5565"></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</s [...]
<dd><p>Move an <a class="reference internal" href="#struct_arrow_buffer"><span
class="std std-ref">ArrowBuffer</span></a>. </p>
<p>Transfers the buffer data and lifecycle management to another address and
resets buffer. </p>
</dd></dl>
@@ -956,6 +963,18 @@
<dd><p>Write a float to a buffer. </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv427ArrowBufferAppendStringViewP11ArrowBuffer15ArrowStringView">
+<span
id="_CPPv327ArrowBufferAppendStringViewP11ArrowBuffer15ArrowStringView"></span><span
id="_CPPv227ArrowBufferAppendStringViewP11ArrowBuffer15ArrowStringView"></span><span
id="ArrowBufferAppendStringView__ArrowBufferP.ArrowStringView"></span><span
class="target"
id="group__nanoarrow-buffer_1ga8dc7c690ccc330cded565c6b69d84062"></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"> </sp [...]
+<dd><p>Write an <a class="reference internal"
href="#struct_arrow_string_view"><span class="std
std-ref">ArrowStringView</span></a> to a buffer. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv427ArrowBufferAppendBufferViewP11ArrowBuffer15ArrowBufferView">
+<span
id="_CPPv327ArrowBufferAppendBufferViewP11ArrowBuffer15ArrowBufferView"></span><span
id="_CPPv227ArrowBufferAppendBufferViewP11ArrowBuffer15ArrowBufferView"></span><span
id="ArrowBufferAppendBufferView__ArrowBufferP.ArrowBufferView"></span><span
class="target"
id="group__nanoarrow-buffer_1gac2cf5770ad82a1fcf9f78cd43919238a"></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"> </sp [...]
+<dd><p>Write an <a class="reference internal"
href="#struct_arrow_buffer_view"><span class="std
std-ref">ArrowBufferView</span></a> to a buffer. </p>
+</dd></dl>
+
</div>
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv420ArrowBufferAllocator">
@@ -1076,6 +1095,13 @@
<p>Initialize the builder’s buffer, empty its cache, and reset the size to
zero </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv415ArrowBitmapMoveP11ArrowBitmapP11ArrowBitmap">
+<span id="_CPPv315ArrowBitmapMoveP11ArrowBitmapP11ArrowBitmap"></span><span
id="_CPPv215ArrowBitmapMoveP11ArrowBitmapP11ArrowBitmap"></span><span
id="ArrowBitmapMove__ArrowBitmapP.ArrowBitmapP"></span><span class="target"
id="group__nanoarrow-bitmap_1ga0080b8cb7bf63665f1f0240c32e37437"></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</s [...]
+<dd><p>Move an <a class="reference internal" href="#struct_arrow_bitmap"><span
class="std std-ref">ArrowBitmap</span></a>. </p>
+<p>Transfers the underlying buffer data and lifecycle management to another
address and resets the bitmap. </p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv418ArrowBitmapReserveP11ArrowBitmap7int64_t">
<span id="_CPPv318ArrowBitmapReserveP11ArrowBitmap7int64_t"></span><span
id="_CPPv218ArrowBitmapReserveP11ArrowBitmap7int64_t"></span><span
id="ArrowBitmapReserve__ArrowBitmapP.int64_t"></span><span class="target"
id="group__nanoarrow-bitmap_1ga8a1080cb4f1cb2dce6110f3ddc198fcb"></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="#_CPPv414Arrow [...]
@@ -1758,6 +1784,27 @@
<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>
+<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="_CPPv415ArrowSchemaMoveP11ArrowSchemaP11ArrowSchema">
+<span id="_CPPv315ArrowSchemaMoveP11ArrowSchemaP11ArrowSchema"></span><span
id="_CPPv215ArrowSchemaMoveP11ArrowSchemaP11ArrowSchema"></span><span
id="ArrowSchemaMove__ArrowSchemaP.ArrowSchemaP"></span><span class="target"
id="group__nanoarrow-arrow-cdata_1ga2f542d961ad0e13e674c5b2345bf362f"></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">vo [...]
+<dd><p>Move the contents of src into dst and set src->release to NULL. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv414ArrowArrayMoveP10ArrowArrayP10ArrowArray">
+<span id="_CPPv314ArrowArrayMoveP10ArrowArrayP10ArrowArray"></span><span
id="_CPPv214ArrowArrayMoveP10ArrowArrayP10ArrowArray"></span><span
id="ArrowArrayMove__ArrowArrayP.ArrowArrayP"></span><span class="target"
id="group__nanoarrow-arrow-cdata_1gaa5e58db4cb7963924bebd14c6b6e8a20"></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><p>Move the contents of src into dst and set src->release to NULL. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp"
id="_CPPv420ArrowArrayStreamMoveP16ArrowArrayStreamP16ArrowArrayStream">
+<span
id="_CPPv320ArrowArrayStreamMoveP16ArrowArrayStreamP16ArrowArrayStream"></span><span
id="_CPPv220ArrowArrayStreamMoveP16ArrowArrayStreamP16ArrowArrayStream"></span><span
id="ArrowArrayStreamMove__ArrowArrayStreamP.ArrowArrayStreamP"></span><span
class="target"
id="group__nanoarrow-arrow-cdata_1ga3b7b6acd65e9978c810b7776457864c6"></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"> [...]
+<dd><p>Move the contents of src into dst and set src->release to NULL. </p>
+</dd></dl>
+
</div>
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv411ArrowSchema">
diff --git a/dev/genindex.html b/dev/genindex.html
index 0fe79ab..228be8f 100644
--- a/dev/genindex.html
+++ b/dev/genindex.html
@@ -357,6 +357,8 @@
<li><a
href="c.html#_CPPv414ArrowArrayInitP10ArrowArray9ArrowType">ArrowArrayInit (C++
function)</a>
</li>
<li><a
href="c.html#_CPPv424ArrowArrayInitFromSchemaP10ArrowArrayP11ArrowSchemaP10ArrowError">ArrowArrayInitFromSchema
(C++ function)</a>
+</li>
+ <li><a
href="c.html#_CPPv414ArrowArrayMoveP10ArrowArrayP10ArrowArray">ArrowArrayMove
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv417ArrowArrayReserveP10ArrowArray7int64_t">ArrowArrayReserve
(C++ function)</a>
</li>
@@ -379,6 +381,8 @@
<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#_CPPv420ArrowArrayStreamMoveP16ArrowArrayStreamP16ArrowArrayStream">ArrowArrayStreamMove
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv424ArrowArrayValidityBitmapP10ArrowArray">ArrowArrayValidityBitmap
(C++ function)</a>
</li>
@@ -413,6 +417,8 @@
<li><a
href="c.html#_CPPv428ArrowArrayViewInitFromSchemaP14ArrowArrayViewP11ArrowSchemaP10ArrowError">ArrowArrayViewInitFromSchema
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv420ArrowArrayViewIsNullP14ArrowArrayView7int64_t">ArrowArrayViewIsNull
(C++ function)</a>
+</li>
+ <li><a
href="c.html#_CPPv418ArrowArrayViewMoveP14ArrowArrayViewP14ArrowArrayView">ArrowArrayViewMove
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv419ArrowArrayViewResetP14ArrowArrayView">ArrowArrayViewReset
(C++ function)</a>
</li>
@@ -441,6 +447,8 @@
<li><a
href="c.html#_CPPv423ArrowBitmapAppendUnsafeP11ArrowBitmap7uint8_t7int64_t">ArrowBitmapAppendUnsafe
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv415ArrowBitmapInitP11ArrowBitmap">ArrowBitmapInit (C++
function)</a>
+</li>
+ <li><a
href="c.html#_CPPv415ArrowBitmapMoveP11ArrowBitmapP11ArrowBitmap">ArrowBitmapMove
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv418ArrowBitmapReserveP11ArrowBitmap7int64_t">ArrowBitmapReserve
(C++ function)</a>
</li>
@@ -475,6 +483,8 @@
<li><a
href="c.html#_CPPv427ArrowBufferAllocatorDefaultv">ArrowBufferAllocatorDefault
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv417ArrowBufferAppendP11ArrowBufferPKv7int64_t">ArrowBufferAppend
(C++ function)</a>
+</li>
+ <li><a
href="c.html#_CPPv427ArrowBufferAppendBufferViewP11ArrowBuffer15ArrowBufferView">ArrowBufferAppendBufferView
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv423ArrowBufferAppendDoubleP11ArrowBufferd">ArrowBufferAppendDouble
(C++ function)</a>
</li>
@@ -489,6 +499,8 @@
<li><a
href="c.html#_CPPv422ArrowBufferAppendInt64P11ArrowBuffer7int64_t">ArrowBufferAppendInt64
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv421ArrowBufferAppendInt8P11ArrowBuffer6int8_t">ArrowBufferAppendInt8
(C++ function)</a>
+</li>
+ <li><a
href="c.html#_CPPv427ArrowBufferAppendStringViewP11ArrowBuffer15ArrowStringView">ArrowBufferAppendStringView
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv423ArrowBufferAppendUInt16P11ArrowBuffer8uint16_t">ArrowBufferAppendUInt16
(C++ function)</a>
</li>
@@ -528,12 +540,12 @@
</li>
<li><a
href="c.html#_CPPv4N15ArrowBufferType30NANOARROW_BUFFER_TYPE_VALIDITYE">ArrowBufferType::NANOARROW_BUFFER_TYPE_VALIDITY
(C++ enumerator)</a>
</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="c.html#_CPPv415ArrowBufferView">ArrowBufferView (C++
struct)</a>
</li>
<li><a
href="c.html#_CPPv4N15ArrowBufferView4dataE">ArrowBufferView::data (C++
member)</a>
</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="c.html#_CPPv4N15ArrowBufferView7n_bytesE">ArrowBufferView::n_bytes (C++
member)</a>
</li>
<li><a href="c.html#_CPPv413ArrowCharViewPKc">ArrowCharView (C++
function)</a>
@@ -629,6 +641,8 @@
<li><a
href="c.html#_CPPv422ArrowSchemaInitDecimalP11ArrowSchema9ArrowType7int32_t7int32_t">ArrowSchemaInitDecimal
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv424ArrowSchemaInitFixedSizeP11ArrowSchema9ArrowType7int32_t">ArrowSchemaInitFixedSize
(C++ function)</a>
+</li>
+ <li><a
href="c.html#_CPPv415ArrowSchemaMoveP11ArrowSchemaP11ArrowSchema">ArrowSchemaMove
(C++ function)</a>
</li>
<li><a
href="c.html#_CPPv420ArrowSchemaSetFormatP11ArrowSchemaPKc">ArrowSchemaSetFormat
(C++ function)</a>
</li>
diff --git a/dev/objects.inv b/dev/objects.inv
index 88ef2fb..209428a 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 16df15d..e3e7ea9 100644
--- a/dev/r/pkgdown.yml
+++ b/dev/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.19.2
pkgdown: 2.0.6
pkgdown_sha: ~
articles: {}
-last_built: 2022-12-02T16:14Z
+last_built: 2022-12-02T19:00Z
diff --git a/dev/r/reference/as_nanoarrow_array.html
b/dev/r/reference/as_nanoarrow_array.html
index 6abb03f..f04d7b6 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 0x56397282b1e8></span>
+<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55d8d6add5e8></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 0x563974c7e118></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55d8d73068d8></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 2e051f1..24284d2 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 0x563974fcf8b8></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55d8d7097a68></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/basic_array_stream.html
b/dev/r/reference/basic_array_stream.html
new file mode 100644
index 0000000..605ef59
--- /dev/null
+++ b/dev/r/reference/basic_array_stream.html
@@ -0,0 +1,114 @@
+<!DOCTYPE html>
+<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta
http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta
charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta
name="viewport" content="width=device-width, initial-scale=1,
shrink-to-fit=no"><meta name="description" content="Create ArrayStreams from
batches"><title>Create ArrayStreams from batches — basic_array_stream •
nanoarrow</title><script src="../deps/jquery-3.6.0/jquery-3.6 [...]
+<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js";></script>
+<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script>
+<![endif]--></head><body>
+ <a href="#main" class="visually-hidden-focusable">Skip to contents</a>
+
+
+ <nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><div
class="container">
+
+ <a class="navbar-brand me-2" href="../index.html">nanoarrow</a>
+
+ <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip"
data-bs-placement="bottom" title="">0.0.0.9000</small>
+
+
+ <button class="navbar-toggler" type="button" data-bs-toggle="collapse"
data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false"
aria-label="Toggle navigation">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+
+ <div id="navbar" class="collapse navbar-collapse ms-3">
+ <ul class="navbar-nav me-auto"><li class="active nav-item">
+ <a class="nav-link" href="../reference/index.html">Reference</a>
+</li>
+ </ul><form class="form-inline my-2 my-lg-0" role="search">
+ <input type="search" class="form-control me-sm-2" aria-label="Toggle
navigation" name="search-input" data-search-index="../search.json"
id="search-input" placeholder="Search for" autocomplete="off"></form>
+
+ <ul class="navbar-nav"><li class="nav-item">
+ <a class="external-link nav-link"
href="https://github.com/apache/arrow-nanoarrow/"; aria-label="github">
+ <span class="fab fa fab fa-github fa-lg"></span>
+
+ </a>
+</li>
+ </ul></div>
+
+
+ </div>
+</nav><div class="container template-reference-topic">
+<div class="row">
+ <main id="main" class="col-md-9"><div class="page-header">
+ <img src="" class="logo" alt=""><h1>Create ArrayStreams from batches</h1>
+ <small class="dont-index">Source: <a
href="https://github.com/apache/arrow-nanoarrow/blob/HEAD/R/array-stream.R";
class="external-link"><code>R/array-stream.R</code></a></small>
+ <div class="d-none name"><code>basic_array_stream.Rd</code></div>
+ </div>
+
+ <div class="ref-description section level2">
+ <p>Create ArrayStreams from batches</p>
+ </div>
+
+ <div class="section level2">
+ <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor"
href="#ref-usage"></a></h2>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span><span
class="fu">basic_array_stream</span><span class="op">(</span><span
class="va">batches</span>, schema <span class="op">=</span> <span
class="cn">NULL</span>, validate <span class="op">=</span> <span
class="cn">TRUE</span><span class="op">)</span></span></code></pre></div>
+ </div>
+
+ <div class="section level2">
+ <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor"
href="#arguments"></a></h2>
+ <dl><dt>batches</dt>
+<dd><p>A <code><a href="https://rdrr.io/r/base/list.html";
class="external-link">list()</a></code> of <a
href="as_nanoarrow_array.html">nanoarrow_array</a> objects
+or objects that can be coerced via <code><a
href="as_nanoarrow_array.html">as_nanoarrow_array()</a></code>.</p></dd>
+
+
+<dt>schema</dt>
+<dd><p>A <a href="as_nanoarrow_schema.html">nanoarrow_schema</a> or
<code>NULL</code> to guess
+based on the first schema.</p></dd>
+
+
+<dt>validate</dt>
+<dd><p>Use <code>FALSE</code> to skip the validation step (i.e., if you
+know that the arrays are valid).</p></dd>
+
+</dl></div>
+ <div class="section level2">
+ <h2 id="value">Value<a class="anchor" aria-label="anchor"
href="#value"></a></h2>
+
+
+<p>An <a href="as_nanoarrow_array_stream.html">nanoarrow_array_stream</a></p>
+
+
+ </div>
+
+ <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="op">(</span><span class="va">stream</span>
<span class="op"><-</span> <span class="fu">basic_array_stream</span><span
class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/list.html";
class="external-link">list</a></span><span class="op">(</span><span
class="fu"><a href="https://rdrr.io/r/base/data.frame.html";
class="external-link">data.frame</a></span><span class="op">(</spa [...]
+<span class="r-out co"><span class="r-pr">#></span>
<nanoarrow_array_stream struct<a: double, b: double>></span>
+<span class="r-out co"><span class="r-pr">#></span> $ get_schema:function
() </span>
+<span class="r-out co"><span class="r-pr">#></span> $ get_next :function
(schema = x$get_schema(), validate = TRUE) </span>
+<span class="r-out co"><span class="r-pr">#></span> $ release :function
() </span>
+<span class="r-in"><span><span class="fu"><a
href="https://rdrr.io/r/base/as.data.frame.html";
class="external-link">as.data.frame</a></span><span class="op">(</span><span
class="va">stream</span><span class="op">$</span><span
class="fu">get_next</span><span class="op">(</span><span
class="op">)</span><span class="op">)</span></span></span>
+<span class="r-out co"><span class="r-pr">#></span> a b</span>
+<span class="r-out co"><span class="r-pr">#></span> 1 1 2</span>
+<span class="r-in"><span><span class="va">stream</span><span
class="op">$</span><span class="fu">get_next</span><span
class="op">(</span><span class="op">)</span></span></span>
+<span class="r-out co"><span class="r-pr">#></span> NULL</span>
+<span class="r-in"><span></span></span>
+</code></pre></div>
+ </div>
+ </main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
+ </nav></aside></div>
+
+
+ <footer><div class="pkgdown-footer-left">
+ <p></p><p>Developed by Dewey Dunnington, Apache Arrow.</p>
+</div>
+
+<div class="pkgdown-footer-right">
+ <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/";
class="external-link">pkgdown</a> 2.0.6.</p>
+</div>
+
+ </footer></div>
+
+
+
+
+
+ </body></html>
+
diff --git a/dev/r/reference/index.html b/dev/r/reference/index.html
index ab9014c..8687304 100644
--- a/dev/r/reference/index.html
+++ b/dev/r/reference/index.html
@@ -68,6 +68,11 @@
<dd>Convert an object to a nanoarrow schema</dd>
</dl><dl><dt>
+ <code><a
href="basic_array_stream.html">basic_array_stream()</a></code>
+ </dt>
+ <dd>Create ArrayStreams from batches</dd>
+ </dl><dl><dt>
+
<code><a href="convert_array.html">convert_array()</a></code>
</dt>
<dd>Convert an Array into an R vector</dd>
diff --git a/dev/r/search.json b/dev/r/search.json
index fc3cf37..5c4c91c 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":"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 [...]
+[{"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":"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 [...]
diff --git a/dev/r/sitemap.xml b/dev/r/sitemap.xml
index 15dab6d..fb32932 100644
--- a/dev/r/sitemap.xml
+++ b/dev/r/sitemap.xml
@@ -21,6 +21,9 @@
<url>
<loc>/reference/as_nanoarrow_schema.html</loc>
</url>
+ <url>
+ <loc>/reference/basic_array_stream.html</loc>
+ </url>
<url>
<loc>/reference/convert_array.html</loc>
</url>
diff --git a/dev/searchindex.js b/dev/searchindex.js
index ddf474d..da843fa 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
