main/r/reference/array_stream_set_finalizer.html - arrow-nanoarrow - Git at Google

 <!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"><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.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Register an array stream finalizer — array_stream_set_finalizer"><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."><meta property="og: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."></head><body>
     <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


     <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><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.5.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>
 <li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
       </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
  <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
 <li class="nav-item"><a class="external-link nav-link" href="https://github.com/apache/arrow-nanoarrow/" aria-label="GitHub"><span class="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">

       <h1>Register an array stream finalizer</h1>
       <small class="dont-index">Source: <a href="https://github.com/apache/arrow-nanoarrow/blob/main/r/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 id="arg-array-stream">array_stream<a class="anchor" aria-label="anchor" href="#arg-array-stream"></a></dt>
 <dd><p>A <a href="as_nanoarrow_array_stream.html">nanoarrow_array_stream</a></p></dd>


 <dt id="arg-finalizer">finalizer<a class="anchor" aria-label="anchor" href="#arg-finalizer"></a></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>A newly allocated <code>array_stream</code> whose release callback will call
 the supplied finalizer.</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">&lt;-</span> <span class="fu">array_stream_set_finalizer</span><span class="op">(</span></span></span>
 <span class="r-in"><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>,</span></span>
 <span class="r-in"><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></span>
 <span class="r-in"><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">#&gt;</span> All done!</span>
 <span class="r-in"><span></span></span>
 </code></pre></div>
     </div>
   </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
     </nav></aside></div>


     <footer><div class="pkgdown-footer-left">
   <p>Developed by Dewey Dunnington, Apache Arrow.</p>
 </div>

 <div class="pkgdown-footer-right">
   <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.0.</p>
 </div>

     </footer></div>


   </body></html>
	<!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"><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.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Register an array stream finalizer — array_stream_set_finalizer"><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."><meta property="og: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."></head><body>
	<a href="#main" class="visually-hidden-focusable">Skip to contents</a>


	<nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><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.5.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>
	<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
	</ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
	<input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
	<li class="nav-item"><a class="external-link nav-link" href="https://github.com/apache/arrow-nanoarrow/" aria-label="GitHub"><span class="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">

	<h1>Register an array stream finalizer</h1>
	<small class="dont-index">Source: <a href="https://github.com/apache/arrow-nanoarrow/blob/main/r/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 id="arg-array-stream">array_stream<a class="anchor" aria-label="anchor" href="#arg-array-stream"></a></dt>
	<dd><p>A <a href="as_nanoarrow_array_stream.html">nanoarrow_array_stream</a></p></dd>


	<dt id="arg-finalizer">finalizer<a class="anchor" aria-label="anchor" href="#arg-finalizer"></a></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>A newly allocated <code>array_stream</code> whose release callback will call
	the supplied finalizer.</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">array_stream_set_finalizer</span><span class="op">(</span></span></span>
	<span class="r-in"><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>,</span></span>
	<span class="r-in"><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></span>
	<span class="r-in"><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" aria-label="Table of contents"><h2>On this page</h2>
	</nav></aside></div>


	<footer><div class="pkgdown-footer-left">
	<p>Developed by Dewey Dunnington, Apache Arrow.</p>
	</div>

	<div class="pkgdown-footer-right">
	<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.0.</p>
	</div>

	</footer></div>





	</body></html>