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 6c37e23 update documentation for tag dev
6c37e23 is described below
commit 6c37e23630177f6e4a170f86c02181a96eccfa07
Author: GitHub Actions <[email protected]>
AuthorDate: Wed May 17 19:00:11 2023 +0000
update documentation for tag dev
---
dev/r/pkgdown.yml | 2 +-
dev/r/reference/array_stream_set_finalizer.html | 123 ++++++++++++++++++++++++
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 | 5 +
dev/r/search.json | 2 +-
dev/r/sitemap.xml | 3 +
8 files changed, 138 insertions(+), 7 deletions(-)
diff --git a/dev/r/pkgdown.yml b/dev/r/pkgdown.yml
index 46f7584..19f3f05 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-17T13:02Z
+last_built: 2023-05-17T19:00Z
diff --git a/dev/r/reference/array_stream_set_finalizer.html
b/dev/r/reference/array_stream_set_finalizer.html
new file mode 100644
index 0000000..7f59293
--- /dev/null
+++ b/dev/r/reference/array_stream_set_finalizer.html
@@ -0,0 +1,123 @@
+<!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="In some cases, R functions
that return a nanoarrow_array_stream
+may require that the scope of some other object outlive that of the array
+stream. If there is a need for that object to be released deterministically
+(e.g., to close open files), you can register a function to run after the
+stream's release callback is invoked from the R thread. Note that this
+finalizer will not be run if the stream's release callback is invoked
+from a non-R thread. In this case, the finalizer and its chain of
+environments will be garbage-collected when nanoarrow:::preserved_empty()
+is run."><title>Register an array stream finalizer —
array_stream_set_finalizer • nanoarrow</title><script
src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport"
content="width=device-width, initial-scale=1, shrink-to-fit=no"><link
href="../deps/bootstrap-5.2.2/bootstrap.min.css" rel="stylesheet"><script
src="../deps/bootstrap-5.2.2/bootstrap.bundle.min.js"></script><!-- Font
Awesome icons --><link rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/font- [...]
+may require that the scope of some other object outlive that of the array
+stream. If there is a need for that object to be released deterministically
+(e.g., to close open files), you can register a function to run after the
+stream's release callback is invoked from the R thread. Note that this
+finalizer will not be run if the stream's release callback is invoked
+from a non-R thread. In this case, the finalizer and its chain of
+environments will be garbage-collected when nanoarrow:::preserved_empty()
+is run."><!-- mathjax --><script
src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js";
integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k="
crossorigin="anonymous"></script><script
src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js";
integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA="
crossorigin="anonymous"></script><!--[if lt IE 9]>
+<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.1.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>Register an array stream
finalizer</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>array_stream_set_finalizer.Rd</code></div>
+ </div>
+
+ <div class="ref-description section level2">
+ <p>In some cases, R functions that return a <a
href="as_nanoarrow_array_stream.html">nanoarrow_array_stream</a>
+may require that the scope of some other object outlive that of the array
+stream. If there is a need for that object to be released deterministically
+(e.g., to close open files), you can register a function to run after the
+stream's release callback is invoked from the R thread. Note that this
+finalizer will <strong>not</strong> be run if the stream's release callback is
invoked
+from a <strong>non</strong>-R thread. In this case, the finalizer and its
chain of
+environments will be garbage-collected when
<code>nanoarrow:::preserved_empty()</code>
+is run.</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">array_stream_set_finalizer</span><span class="op">(</span><span
class="va">array_stream</span>, <span class="va">finalizer</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>array_stream</dt>
+<dd><p>A <a
href="as_nanoarrow_array_stream.html">nanoarrow_array_stream</a></p></dd>
+
+
+<dt>finalizer</dt>
+<dd><p>A function that will be called with zero arguments.</p></dd>
+
+</dl></div>
+ <div class="section level2">
+ <h2 id="value">Value<a class="anchor" aria-label="anchor"
href="#value"></a></h2>
+
+
+<p><code>array_stream</code>, invisibly</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="va">stream</span> <span class="op"><-</span>
<span class="fu"><a
href="basic_array_stream.html">basic_array_stream</a></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="fl">1</span><span class="op">:</span><span class="fl">5</span><span
class="op">)</span><span class="op">)< [...]
+<span class="r-in"><span><span
class="fu">array_stream_set_finalizer</span><span class="op">(</span><span
class="va">stream</span>, <span class="kw">function</span><span
class="op">(</span><span class="op">)</span> <span class="fu"><a
href="https://rdrr.io/r/base/message.html";
class="external-link">message</a></span><span class="op">(</span><span
class="st">"All done!"</span><span class="op">)</span><span
class="op">)</span></span></span>
+<span class="r-in"><span><span class="va">stream</span><span
class="op">$</span><span class="fu">release</span><span
class="op">(</span><span class="op">)</span></span></span>
+<span class="r-msg co"><span class="r-pr">#></span> All done!</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.7.</p>
+</div>
+
+ </footer></div>
+
+
+
+
+
+ </body></html>
+
diff --git a/dev/r/reference/as_nanoarrow_array.html
b/dev/r/reference/as_nanoarrow_array.html
index 9a4591a..9253e93 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 0x55e6b8e18238></span>
+<span class="r-out co"><span class="r-pr">#></span> ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x5582deee6e98></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 0x55e6b87f1d88></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x5582dfaf8cb8></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 3d579b5..162075c 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 0x55e6b8bcafe8></span>
+<span class="r-out co"><span class="r-pr">#></span> .. .. ..$
:<nanoarrow_buffer_data_int32[20 b] at 0x5582e0f44068></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 5c095b6..bfbe1b8 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 0x55e6ba863f78></span>
+<span class="r-out co"><span class="r-pr">#></span>
<nanoarrow_buffer_data_int32[16 b] at 0x5582dfe2ca18></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 0x55e6baad5f38></span>
+<span class="r-out co"><span class="r-pr">#></span> <nanoarrow_buffer[20
b] at 0x5582dfe93a88></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 be9f866..b1d6a71 100644
--- a/dev/r/reference/index.html
+++ b/dev/r/reference/index.html
@@ -53,6 +53,11 @@
<dl><dt>
+ <code><a
href="array_stream_set_finalizer.html">array_stream_set_finalizer()</a></code>
+ </dt>
+ <dd>Register an array stream finalizer</dd>
+ </dl><dl><dt>
+
<code><a
href="as_nanoarrow_array.html">as_nanoarrow_array()</a></code>
</dt>
<dd>Convert an object to a nanoarrow array</dd>
diff --git a/dev/r/search.json b/dev/r/search.json
index b0b7b9b..67fc6fc 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/r/sitemap.xml b/dev/r/sitemap.xml
index f258b4f..20b86b3 100644
--- a/dev/r/sitemap.xml
+++ b/dev/r/sitemap.xml
@@ -12,6 +12,9 @@
<url>
<loc>/index.html</loc>
</url>
+ <url>
+ <loc>/reference/array_stream_set_finalizer.html</loc>
+ </url>
<url>
<loc>/reference/as_nanoarrow_array.html</loc>
</url>
