blob: 9f07e8ab9efb03fb80f587fe05cbefbc0797052c [file] [log] [blame]
<!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>Function reference • 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><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.jsdelivr.net/gh/afeld/bootstrap-toc@v1.0.1/dist/bootstrap-toc.min.js" integrity="sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.11/clipboard.min.js" integrity="sha512-7O5pXpc0oCRrxk8RUfDYFgn0nO1t+jLuIOQdOMRp4APB7uZ4vSjspzp5y6YDtDs4VzUSTbWzBFZ/LKJhnyFOKw==" crossorigin="anonymous" referrerpolicy="no-referrer"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Function reference"><!-- 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" data-bs-theme="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.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><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-index">
<div class="row">
<main id="main" class="col-md-9"><div class="page-header">
<img src="" class="logo" alt=""><h1>Function reference</h1>
</div>
<div class="section level2">
<h2 id="all-functions">All functions<a class="anchor" aria-label="anchor" href="#all-functions"></a></h2>
</div><div id="" class="section level2">
<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>
</dl><dl><dt>
<code><a href="as_nanoarrow_array_stream.html">as_nanoarrow_array_stream()</a></code>
</dt>
<dd>Convert an object to a nanoarrow array_stream</dd>
</dl><dl><dt>
<code><a href="as_nanoarrow_buffer.html">as_nanoarrow_buffer()</a></code>
</dt>
<dd>Convert an object to a nanoarrow buffer</dd>
</dl><dl><dt>
<code><a href="as_nanoarrow_schema.html">as_nanoarrow_schema()</a></code> <code><a href="as_nanoarrow_schema.html">infer_nanoarrow_schema()</a></code> <code><a href="as_nanoarrow_schema.html">nanoarrow_schema_parse()</a></code> <code><a href="as_nanoarrow_schema.html">nanoarrow_schema_modify()</a></code>
</dt>
<dd>Convert an object to a nanoarrow schema</dd>
</dl><dl><dt>
<code><a href="as_nanoarrow_vctr.html">as_nanoarrow_vctr()</a></code> <code><a href="as_nanoarrow_vctr.html">nanoarrow_vctr()</a></code>
</dt>
<dd>Experimental Arrow encoded arrays as R vectors</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>
</dl><dl><dt>
<code><a href="convert_array_stream.html">convert_array_stream()</a></code> <code><a href="convert_array_stream.html">collect_array_stream()</a></code>
</dt>
<dd>Convert an Array Stream into an R vector</dd>
</dl><dl><dt>
<code><a href="infer_nanoarrow_ptype.html">infer_nanoarrow_ptype()</a></code>
</dt>
<dd>Infer an R vector prototype</dd>
</dl><dl><dt>
<code><a href="infer_nanoarrow_ptype_extension.html">infer_nanoarrow_ptype_extension()</a></code> <code><a href="infer_nanoarrow_ptype_extension.html">convert_array_extension()</a></code> <code><a href="infer_nanoarrow_ptype_extension.html">as_nanoarrow_array_extension()</a></code>
</dt>
<dd>Implement Arrow extension types</dd>
</dl><dl><dt>
<code><a href="na_type.html">na_type()</a></code> <code><a href="na_type.html">na_na()</a></code> <code><a href="na_type.html">na_bool()</a></code> <code><a href="na_type.html">na_int8()</a></code> <code><a href="na_type.html">na_uint8()</a></code> <code><a href="na_type.html">na_int16()</a></code> <code><a href="na_type.html">na_uint16()</a></code> <code><a href="na_type.html">na_int32()</a></code> <code><a href="na_type.html">na_uint32()</a></code> <code><a href="na_type.html">na_int64()</a></code> <code><a href="na_type.html">na_uint64()</a></code> <code><a href="na_type.html">na_half_float()</a></code> <code><a href="na_type.html">na_float()</a></code> <code><a href="na_type.html">na_double()</a></code> <code><a href="na_type.html">na_string()</a></code> <code><a href="na_type.html">na_large_string()</a></code> <code><a href="na_type.html">na_binary()</a></code> <code><a href="na_type.html">na_large_binary()</a></code> <code><a href="na_type.html">na_fixed_size_binary()</a></code> <code><a href="na_type.html">na_date32()</a></code> <code><a href="na_type.html">na_date64()</a></code> <code><a href="na_type.html">na_time32()</a></code> <code><a href="na_type.html">na_time64()</a></code> <code><a href="na_type.html">na_duration()</a></code> <code><a href="na_type.html">na_interval_months()</a></code> <code><a href="na_type.html">na_interval_day_time()</a></code> <code><a href="na_type.html">na_interval_month_day_nano()</a></code> <code><a href="na_type.html">na_timestamp()</a></code> <code><a href="na_type.html">na_decimal128()</a></code> <code><a href="na_type.html">na_decimal256()</a></code> <code><a href="na_type.html">na_struct()</a></code> <code><a href="na_type.html">na_sparse_union()</a></code> <code><a href="na_type.html">na_dense_union()</a></code> <code><a href="na_type.html">na_list()</a></code> <code><a href="na_type.html">na_large_list()</a></code> <code><a href="na_type.html">na_fixed_size_list()</a></code> <code><a href="na_type.html">na_map()</a></code> <code><a href="na_type.html">na_dictionary()</a></code> <code><a href="na_type.html">na_extension()</a></code>
</dt>
<dd>Create type objects</dd>
</dl><dl><dt>
<code><a href="na_vctrs.html">na_vctrs()</a></code>
</dt>
<dd>Vctrs extension type</dd>
</dl><dl><dt>
<code><a href="nanoarrow_array_init.html">nanoarrow_array_init()</a></code> <code><a href="nanoarrow_array_init.html">nanoarrow_array_set_schema()</a></code> <code><a href="nanoarrow_array_init.html">nanoarrow_array_modify()</a></code>
</dt>
<dd>Modify nanoarrow arrays</dd>
</dl><dl><dt>
<code><a href="nanoarrow_buffer_init.html">nanoarrow_buffer_init()</a></code> <code><a href="nanoarrow_buffer_init.html">nanoarrow_buffer_append()</a></code> <code><a href="nanoarrow_buffer_init.html">convert_buffer()</a></code>
</dt>
<dd>Create and modify nanoarrow buffers</dd>
</dl><dl><dt>
<code><a href="nanoarrow_extension_array.html">nanoarrow_extension_array()</a></code>
</dt>
<dd>Create Arrow extension arrays</dd>
</dl><dl><dt>
<code><a href="nanoarrow_extension_spec.html">nanoarrow_extension_spec()</a></code> <code><a href="nanoarrow_extension_spec.html">register_nanoarrow_extension()</a></code> <code><a href="nanoarrow_extension_spec.html">unregister_nanoarrow_extension()</a></code> <code><a href="nanoarrow_extension_spec.html">resolve_nanoarrow_extension()</a></code>
</dt>
<dd>Register Arrow extension types</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_valid.html">nanoarrow_pointer_move()</a></code> <code><a href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_export()</a></code> <code><a href="nanoarrow_pointer_is_valid.html">nanoarrow_allocate_schema()</a></code> <code><a href="nanoarrow_pointer_is_valid.html">nanoarrow_allocate_array()</a></code> <code><a href="nanoarrow_pointer_is_valid.html">nanoarrow_allocate_array_stream()</a></code> <code><a href="nanoarrow_pointer_is_valid.html">nanoarrow_pointer_set_protected()</a></code>
</dt>
<dd>Danger zone: low-level pointer operations</dd>
</dl><dl><dt>
<code><a href="nanoarrow_version.html">nanoarrow_version()</a></code>
</dt>
<dd>Underlying 'nanoarrow' C library build</dd>
</dl><dl><dt>
<code><a href="read_nanoarrow.html">read_nanoarrow()</a></code> <code><a href="read_nanoarrow.html">example_ipc_stream()</a></code>
</dt>
<dd>Read serialized streams of Arrow data</dd>
</dl></div>
</main></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.0.9.</p>
</div>
</footer></div>
</body></html>