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 4dc2c92 update documentation for tag dev
4dc2c92 is described below
commit 4dc2c921ccf3cb38d4f43dc76b4e7385cc86881c
Author: GitHub Actions <[email protected]>
AuthorDate: Tue May 16 12:44:03 2023 +0000
update documentation for tag dev
---
dev/c.html | 4 ++--
dev/cpp.html | 4 ++--
dev/genindex.html | 2 +-
dev/getting-started.html | 4 ++--
dev/getting-started_generated.html | 4 ++--
dev/index.html | 4 ++--
dev/ipc.html | 4 ++--
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/as_nanoarrow_buffer.html | 4 ++--
dev/r/reference/index.html | 2 +-
dev/r/reference/nanoarrow_pointer_is_valid.html | 11 ++++++++++-
dev/r/search.json | 2 +-
dev/search.html | 2 +-
15 files changed, 32 insertions(+), 23 deletions(-)
diff --git a/dev/c.html b/dev/c.html
index 5b9d80e..9bb2583 100644
--- a/dev/c.html
+++ b/dev/c.html
@@ -6,7 +6,7 @@
<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/"; />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0"
/><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>C API Reference — nanoarrow documentation</title>
@@ -2361,7 +2361,7 @@ document.write(`
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.0.0.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.0.1.
<br/>
</p>
</div>
diff --git a/dev/cpp.html b/dev/cpp.html
index f7d5164..ae00136 100644
--- a/dev/cpp.html
+++ b/dev/cpp.html
@@ -6,7 +6,7 @@
<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/"; />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0"
/><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>C++ API Reference — nanoarrow documentation</title>
@@ -774,7 +774,7 @@ document.write(`
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.0.0.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.0.1.
<br/>
</p>
</div>
diff --git a/dev/genindex.html b/dev/genindex.html
index 2feb06a..0361f8d 100644
--- a/dev/genindex.html
+++ b/dev/genindex.html
@@ -1155,7 +1155,7 @@ document.write(`
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.0.0.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.0.1.
<br/>
</p>
</div>
diff --git a/dev/getting-started.html b/dev/getting-started.html
index 3bb238a..4ce86c4 100644
--- a/dev/getting-started.html
+++ b/dev/getting-started.html
@@ -6,7 +6,7 @@
<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/"; />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0"
/><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Getting started with nanoarrow — nanoarrow
documentation</title>
@@ -975,7 +975,7 @@ exposing an Arrow-based API implemented using the nanoarrow
C library.</p>
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.0.0.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.0.1.
<br/>
</p>
</div>
diff --git a/dev/getting-started_generated.html
b/dev/getting-started_generated.html
index 181402c..c7bd944 100644
--- a/dev/getting-started_generated.html
+++ b/dev/getting-started_generated.html
@@ -6,7 +6,7 @@
<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/"; />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0"
/><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Getting started with nanoarrow — nanoarrow
documentation</title>
@@ -955,7 +955,7 @@ exposing an Arrow-based API implemented using the nanoarrow
C library.</p>
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.0.0.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.0.1.
<br/>
</p>
</div>
diff --git a/dev/index.html b/dev/index.html
index 25b8535..201b862 100644
--- a/dev/index.html
+++ b/dev/index.html
@@ -6,7 +6,7 @@
<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/"; />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0"
/><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>nanoarrow — nanoarrow documentation</title>
@@ -570,7 +570,7 @@ repository.</p>
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.0.0.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.0.1.
<br/>
</p>
</div>
diff --git a/dev/ipc.html b/dev/ipc.html
index f316030..082362c 100644
--- a/dev/ipc.html
+++ b/dev/ipc.html
@@ -6,7 +6,7 @@
<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/"; />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0"
/><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>IPC Extension Reference — nanoarrow documentation</title>
@@ -890,7 +890,7 @@ document.write(`
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.0.0.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.0.1.
<br/>
</p>
</div>
diff --git a/dev/r/pkgdown.yml b/dev/r/pkgdown.yml
index 0dce7a7..130e9fc 100644
--- a/dev/r/pkgdown.yml
+++ b/dev/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.9.2.1
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
-last_built: 2023-05-12T14:54Z
+last_built: 2023-05-16T12:43Z
diff --git a/dev/r/reference/as_nanoarrow_array.html
b/dev/r/reference/as_nanoarrow_array.html
index 3623e54..8bfecf7 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 0x564255384ec8></span>
+<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55b58dfb1378></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 0x564254356308></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55b58dd6db08></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 7ac34f2..83d039a 100644
--- a/dev/r/reference/as_nanoarrow_array_stream.html
+++ b/dev/r/reference/as_nanoarrow_array_stream.html
@@ -133,7 +133,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 0x564255204978></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x55b58dd01238></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_buffer.html
b/dev/r/reference/as_nanoarrow_buffer.html
index 62742db..6fc4032 100644
--- a/dev/r/reference/as_nanoarrow_buffer.html
+++ b/dev/r/reference/as_nanoarrow_buffer.html
@@ -72,12 +72,12 @@
<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="va">array</span> <span class="op"><-</span>
<span class="fu"><a
href="as_nanoarrow_array.html">as_nanoarrow_array</a></span><span
class="op">(</span><span class="fl">1</span><span class="op">:</span><span
class="fl">4</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">array</span><span
class="op">$</span><span class="va">buffers</span><span
class="op">[[</span><span class="fl">2</span><span class="op">]</span><span
class="op">]</span></span></span>
-<span class="r-out co"><span class="r-pr">#></span>
<nanoarrow_buffer_data_int32[16 b] at 0x564256da6ff8></span>
+<span class="r-out co"><span class="r-pr">#></span>
<nanoarrow_buffer_data_int32[16 b] at 0x55b58fa17288></span>
<span class="r-in"><span><span class="fu"><a
href="https://rdrr.io/r/base/raw.html";
class="external-link">as.raw</a></span><span class="op">(</span><span
class="va">array</span><span class="op">$</span><span
class="va">buffers</span><span class="op">[[</span><span
class="fl">2</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> [1] 01 00 00 00 02 00
00 00 03 00 00 00 04 00 00 00</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="fu">as_nanoarrow_buffer</span><span
class="op">(</span><span class="fl">1</span><span class="op">:</span><span
class="fl">5</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#></span> <nanoarrow_buffer[20
b] at 0x56425708f718></span>
+<span class="r-out co"><span class="r-pr">#></span> <nanoarrow_buffer[20
b] at 0x55b58fc892e8></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="va">buffer</span> <span
class="op"><-</span> <span class="fu">as_nanoarrow_buffer</span><span
class="op">(</span><span class="cn">NULL</span><span
class="op">)</span></span></span>
<span class="r-in"><span></span></span>
diff --git a/dev/r/reference/index.html b/dev/r/reference/index.html
index 8107ca7..be9f866 100644
--- a/dev/r/reference/index.html
+++ b/dev/r/reference/index.html
@@ -108,7 +108,7 @@
<dd>Create and modify nanoarrow buffers</dd>
</dl><dl><dt>
- <code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_is_valid()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_addr_dbl()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_addr_chr()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_addr_pretty()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_release()</a></code>
<code><a href="nanoarrow_pointer_is_vali [...]
+ <code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_is_valid()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_addr_dbl()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_addr_chr()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_addr_pretty()</a></code>
<code><a
href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_release()</a></code>
<code><a href="nanoarrow_pointer_is_vali [...]
</dt>
<dd>Danger zone: low-level pointer operations</dd>
</dl><dl><dt>
diff --git a/dev/r/reference/nanoarrow_pointer_is_valid.html
b/dev/r/reference/nanoarrow_pointer_is_valid.html
index 0525b6d..cbaefdc 100644
--- a/dev/r/reference/nanoarrow_pointer_is_valid.html
+++ b/dev/r/reference/nanoarrow_pointer_is_valid.html
@@ -87,7 +87,9 @@ non-null.</p>
<span></span>
<span><span class="fu">nanoarrow_allocate_array</span><span
class="op">(</span><span class="op">)</span></span>
<span></span>
-<span><span class="fu">nanoarrow_allocate_array_stream</span><span
class="op">(</span><span class="op">)</span></span></code></pre></div>
+<span><span class="fu">nanoarrow_allocate_array_stream</span><span
class="op">(</span><span class="op">)</span></span>
+<span></span>
+<span><span class="fu">nanoarrow_pointer_set_protected</span><span
class="op">(</span><span class="va">ptr_src</span>, <span
class="va">protected</span><span class="op">)</span></span></code></pre></div>
</div>
<div class="section level2">
@@ -96,6 +98,13 @@ non-null.</p>
<dd><p>An external pointer to a <code>struct ArrowSchema</code>,
<code>struct ArrowArray</code>, or <code>struct
ArrowArrayStream</code>.</p></dd>
+
+<dt>protected</dt>
+<dd><p>An object whose scope must outlive that of <code>ptr</code>. This is
+useful for array streams since at least two specifications involving the
+array stream specify that the stream is only valid for the lifecycle of
+another object (e.g., an AdbcStatement or OGRDataset).</p></dd>
+
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor"
href="#value"></a></h2>
diff --git a/dev/r/search.json b/dev/r/search.json
index 2e24cde..e3affab 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 11eb9df..2f65332 100644
--- a/dev/search.html
+++ b/dev/search.html
@@ -410,7 +410,7 @@ document.write(`
<div class="footer-item">
<p class="sphinx-version">
- Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.0.0.
+ Created using <a href="https://www.sphinx-doc.org/";>Sphinx</a> 7.0.1.
<br/>
</p>
</div>
