| <!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 Arrow extension types — nanoarrow_extension_spec • 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 Arrow extension types — nanoarrow_extension_spec"><meta name="description" content="Register Arrow extension types"><meta property="og:description" content="Register Arrow extension types"></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 Arrow extension types</h1> |
| <small class="dont-index">Source: <a href="https://github.com/apache/arrow-nanoarrow/blob/main/r/R/extension.R" class="external-link"><code>R/extension.R</code></a></small> |
| <div class="d-none name"><code>nanoarrow_extension_spec.Rd</code></div> |
| </div> |
| |
| <div class="ref-description section level2"> |
| <p>Register Arrow extension types</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">nanoarrow_extension_spec</span><span class="op">(</span>data <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="op">)</span>, subclass <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/character.html" class="external-link">character</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">register_nanoarrow_extension</span><span class="op">(</span><span class="va">extension_name</span>, <span class="va">extension_spec</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">unregister_nanoarrow_extension</span><span class="op">(</span><span class="va">extension_name</span><span class="op">)</span></span> |
| <span></span> |
| <span><span class="fu">resolve_nanoarrow_extension</span><span class="op">(</span><span class="va">extension_name</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-data">data<a class="anchor" aria-label="anchor" href="#arg-data"></a></dt> |
| <dd><p>Optional data to include in the extension type specification</p></dd> |
| |
| |
| <dt id="arg-subclass">subclass<a class="anchor" aria-label="anchor" href="#arg-subclass"></a></dt> |
| <dd><p>A subclass for the extension type specification. Extension |
| methods will dispatch on this object.</p></dd> |
| |
| |
| <dt id="arg-extension-name">extension_name<a class="anchor" aria-label="anchor" href="#arg-extension-name"></a></dt> |
| <dd><p>An Arrow extension type name (e.g., arrow.r.vctrs)</p></dd> |
| |
| |
| <dt id="arg-extension-spec">extension_spec<a class="anchor" aria-label="anchor" href="#arg-extension-spec"></a></dt> |
| <dd><p>An extension specification inheriting from |
| 'nanoarrow_extension_spec'.</p></dd> |
| |
| </dl></div> |
| <div class="section level2"> |
| <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2> |
| |
| <ul><li><p><code>nanoarrow_extension_spec()</code> returns an object of class |
| 'nanoarrow_extension_spec'.</p></li> |
| <li><p><code>register_nanoarrow_extension()</code> returns <code>extension_spec</code>, invisibly.</p></li> |
| <li><p><code>unregister_nanoarrow_extension()</code> returns <code>extension_name</code>, invisibly.</p></li> |
| <li><p><code>resolve_nanoarrow_extension()</code> returns an object of class |
| 'nanoarrow_extension_spec' or NULL if the extension type was not |
| registered.</p></li> |
| </ul></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="fu">nanoarrow_extension_spec</span><span class="op">(</span><span class="st">"mynamespace.mytype"</span>, subclass <span class="op">=</span> <span class="st">"mypackage_mytype_spec"</span><span class="op">)</span></span></span> |
| <span class="r-out co"><span class="r-pr">#></span> [1] "mynamespace.mytype"</span> |
| <span class="r-out co"><span class="r-pr">#></span> attr(,"class")</span> |
| <span class="r-out co"><span class="r-pr">#></span> [1] "mypackage_mytype_spec" "nanoarrow_extension_spec"</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> |
| |
