This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-nanoarrow.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 77a71cdd update documentation for tag main
77a71cdd is described below
commit 77a71cdd6d1c069f966fd04bb35d7c7e8bb1237a
Author: GitHub Actions <[email protected]>
AuthorDate: Wed Nov 20 04:18:14 2024 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1514798 -> 1516063 bytes
main/.doctrees/reference/python/schema.doctree | Bin 296236 -> 314498 bytes
main/genindex.html | 11 ++
main/objects.inv | Bin 24996 -> 25006 bytes
main/r/pkgdown.yml | 2 +-
main/reference/python/index.html | 1 +
main/reference/python/schema.html | 153 ++++++++++++++++---------
main/searchindex.js | 2 +-
8 files changed, 113 insertions(+), 56 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 84218c57..a55b4a40 100644
Binary files a/main/.doctrees/environment.pickle and
b/main/.doctrees/environment.pickle differ
diff --git a/main/.doctrees/reference/python/schema.doctree
b/main/.doctrees/reference/python/schema.doctree
index 64c5d8ba..66ce228f 100644
Binary files a/main/.doctrees/reference/python/schema.doctree and
b/main/.doctrees/reference/python/schema.doctree differ
diff --git a/main/genindex.html b/main/genindex.html
index 5ea71412..cda3858b 100644
--- a/main/genindex.html
+++ b/main/genindex.html
@@ -334,6 +334,7 @@
| <a href="#E"><strong>E</strong></a>
| <a href="#F"><strong>F</strong></a>
| <a href="#I"><strong>I</strong></a>
+ | <a href="#K"><strong>K</strong></a>
| <a href="#L"><strong>L</strong></a>
| <a href="#M"><strong>M</strong></a>
| <a href="#N"><strong>N</strong></a>
@@ -1504,6 +1505,14 @@
</ul></td>
</tr></table>
+<h2 id="K">K</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a
href="reference/python/schema.html#nanoarrow.schema.Schema.key_type">key_type
(Schema property)</a>
+</li>
+ </ul></td>
+</tr></table>
+
<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
@@ -1525,6 +1534,8 @@
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="reference/python/schema.html#nanoarrow.schema.map_">map_()
(in module nanoarrow.schema)</a>
+</li>
<li><a
href="reference/python/schema.html#nanoarrow.schema.ExtensionAccessor.metadata">metadata
(ExtensionAccessor property)</a>
<ul>
diff --git a/main/objects.inv b/main/objects.inv
index 9e49f838..a94b9b4c 100644
Binary files a/main/objects.inv and b/main/objects.inv differ
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index f74f52e9..1191bd1a 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,4 +2,4 @@ pandoc: 3.1.3
pkgdown: 2.1.1
pkgdown_sha: ~
articles: {}
-last_built: 2024-11-19T21:58Z
+last_built: 2024-11-20T04:17Z
diff --git a/main/reference/python/index.html b/main/reference/python/index.html
index 331f6a88..e619e9c6 100644
--- a/main/reference/python/index.html
+++ b/main/reference/python/index.html
@@ -415,6 +415,7 @@ Arrow C Data and Arrow C Stream interfaces.</p>
<li class="toctree-l2"><a class="reference internal"
href="schema.html#nanoarrow.schema.large_list"><code class="docutils literal
notranslate"><span class="pre">large_list()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal"
href="schema.html#nanoarrow.schema.large_string"><code class="docutils literal
notranslate"><span class="pre">large_string()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal"
href="schema.html#nanoarrow.schema.list_"><code class="docutils literal
notranslate"><span class="pre">list_()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal"
href="schema.html#nanoarrow.schema.map_"><code class="docutils literal
notranslate"><span class="pre">map_()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal"
href="schema.html#nanoarrow.schema.null"><code class="docutils literal
notranslate"><span class="pre">null()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal"
href="schema.html#nanoarrow.schema.schema"><code class="docutils literal
notranslate"><span class="pre">schema()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal"
href="schema.html#nanoarrow.schema.string"><code class="docutils literal
notranslate"><span class="pre">string()</span></code></a></li>
diff --git a/main/reference/python/schema.html
b/main/reference/python/schema.html
index 61235ec5..f714a9c8 100644
--- a/main/reference/python/schema.html
+++ b/main/reference/python/schema.html
@@ -520,6 +520,17 @@ See also <a class="reference internal"
href="#nanoarrow.schema.Schema.value_type
</div>
</dd></dl>
+<dl class="py property">
+<dt class="sig sig-object py" id="nanoarrow.schema.Schema.key_type">
+<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">key_type</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><a class="reference
internal" href="#nanoarrow.schema.Schema" title="nanoarrow.schema.Schema"><span
class="pre">Schema</span></a><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><span class="pre" [...]
+<dd><p>Map key type</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
+<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">map_</span><span class="p">(</span><span
class="n">na</span><span class="o">.</span><span class="n">int32</span><span
class="p">(),</span> <span class="n">na</span><span class="o">.</span><span
class="n">string</span><span class="p">())</span><span class="o">.</span><span
class="n">key_type</span>
+<span class="go"><Schema> 'key': non-nullable int32</span>
+</pre></div>
+</div>
+</dd></dl>
+
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.list_size">
<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">list_size</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span
class="pre">int</span><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><span
class="pre">None</span></em><a class="headerlink"
href="#nanoarrow.schema.Schema.list_size" title="Link to this [...]
@@ -668,11 +679,13 @@ for timezone types for which the timezone is not set.</p>
<dl class="py property">
<dt class="sig sig-object py" id="nanoarrow.schema.Schema.value_type">
-<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">value_type</span></span><a class="headerlink"
href="#nanoarrow.schema.Schema.value_type" title="Link to this
definition">#</a></dt>
-<dd><p>Dictionary or list value type</p>
+<em class="property"><span class="pre">property</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">value_type</span></span><em class="property"><span class="p"><span
class="pre">:</span></span><span class="w"> </span><a class="reference
internal" href="#nanoarrow.schema.Schema" title="nanoarrow.schema.Schema"><span
class="pre">Schema</span></a><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><span class="pr [...]
+<dd><p>Dictionary, map, or list value type</p>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">list_</span><span class="p">(</span><span
class="n">na</span><span class="o">.</span><span class="n">int32</span><span
class="p">())</span><span class="o">.</span><span class="n">value_type</span>
<span class="go"><Schema> 'item': int32</span>
+<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">map_</span><span class="p">(</span><span
class="n">na</span><span class="o">.</span><span class="n">int32</span><span
class="p">(),</span> <span class="n">na</span><span class="o">.</span><span
class="n">string</span><span class="p">())</span><span class="o">.</span><span
class="n">value_type</span>
+<span class="go"><Schema> 'value': string</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">dictionary</span><span
class="p">(</span><span class="n">na</span><span class="o">.</span><span
class="n">int32</span><span class="p">(),</span> <span class="n">na</span><span
class="o">.</span><span class="n">string</span><span class="p">())</span><span
class="o">.</span><span class="n">value_type</span>
<span class="go"><Schema> string</span>
</pre></div>
@@ -868,7 +881,7 @@ between 1 and 76.</p>
<dl class="py function">
<dt class="sig sig-object py" id="nanoarrow.schema.dictionary">
-<span class="sig-name descname"><span
class="pre">dictionary</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">index_type</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">value_type</span></span></em>, <em
class="sig-param"><span class="n"><span
class="pre">dictionary_ordered</span></span><span class="o"><span
class="pre">=</span></span><span class="default_value"><span
class="pre">False</span></span></em><span [...]
+<span class="sig-name descname"><span
class="pre">dictionary</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">index_type</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">value_type</span></span></em>, <em
class="sig-param"><span class="n"><span
class="pre">dictionary_ordered</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span [...]
<dd><p>Create a type representing dictionary-encoded values</p>
<section id="id16">
<h2>Parameters<a class="headerlink" href="#id16" title="Link to this
heading">#</a></h2>
@@ -896,7 +909,7 @@ meaningful.</p>
<dl class="py function">
<dt class="sig sig-object py" id="nanoarrow.schema.duration">
-<span class="sig-name descname"><span class="pre">duration</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">unit</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span c [...]
+<span class="sig-name descname"><span class="pre">duration</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">unit</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span c [...]
<dd><p>Create an instance of a duration type.</p>
<section id="id18">
<h2>Parameters<a class="headerlink" href="#id18" title="Link to this
heading">#</a></h2>
@@ -960,7 +973,7 @@ extension type.</p>
<dl class="py function">
<dt class="sig sig-object py" id="nanoarrow.schema.fixed_size_list">
-<span class="sig-name descname"><span
class="pre">fixed_size_list</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">value_type</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">list_size</span></span></em>, <em
class="sig-param"><span class="n"><span class="pre">nullable</span></span><span
class="o"><span class="pre">=</span></span><span class="default_value"><span
class="pre">True</span></span></em><span class= [...]
+<span class="sig-name descname"><span
class="pre">fixed_size_list</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">value_type</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">list_size</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span [...]
<dd><p>Create a type representing a fixed-size list of some other type.</p>
<section id="id23">
<h2>Parameters<a class="headerlink" href="#id23" title="Link to this
heading">#</a></h2>
@@ -1132,7 +1145,7 @@ extension type.</p>
<dl class="py function">
<dt class="sig sig-object py" id="nanoarrow.schema.interval_day_time">
-<span class="sig-name descname"><span
class="pre">interval_day_time</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">nullable</span></span><span
class="p"><span class="pre">:</span></span><span class="w"> </span><span
class="n"><span class="pre">bool</span></span><span class="w"> </span><span
class="o"><span class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span clas [...]
+<span class="sig-name descname"><span
class="pre">interval_day_time</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">nullable</span></span><span
class="p"><span class="pre">:</span></span><span class="w"> </span><span
class="n"><span class="pre">bool</span></span><span class="w"> </span><span
class="o"><span class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span clas [...]
<dd><p>Create an instance of an interval type measured as a day/time pair.</p>
<section id="id39">
<h2>Parameters<a class="headerlink" href="#id39" title="Link to this
heading">#</a></h2>
@@ -1153,7 +1166,7 @@ extension type.</p>
<dl class="py function">
<dt class="sig sig-object py" id="nanoarrow.schema.interval_month_day_nano">
-<span class="sig-name descname"><span
class="pre">interval_month_day_nano</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><spa [...]
+<span class="sig-name descname"><span
class="pre">interval_month_day_nano</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><spa [...]
<dd><p>Create an instance of an interval type measured as a
month/day/nanosecond
tuple.</p>
<section id="id41">
@@ -1175,7 +1188,7 @@ tuple.</p>
<dl class="py function">
<dt class="sig sig-object py" id="nanoarrow.schema.interval_months">
-<span class="sig-name descname"><span
class="pre">interval_months</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">nullable</span></span><span
class="p"><span class="pre">:</span></span><span class="w"> </span><span
class="n"><span class="pre">bool</span></span><span class="w"> </span><span
class="o"><span class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span class=
[...]
+<span class="sig-name descname"><span
class="pre">interval_months</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">nullable</span></span><span
class="p"><span class="pre">:</span></span><span class="w"> </span><span
class="n"><span class="pre">bool</span></span><span class="w"> </span><span
class="o"><span class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span class=
[...]
<dd><p>Create an instance of an interval type measured in months.</p>
<section id="id43">
<h2>Parameters<a class="headerlink" href="#id43" title="Link to this
heading">#</a></h2>
@@ -1217,7 +1230,7 @@ tuple.</p>
<dl class="py function">
<dt class="sig sig-object py" id="nanoarrow.schema.large_list">
-<span class="sig-name descname"><span
class="pre">large_list</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">value_type</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">nullable</span></span><span class="o"><span
class="pre">=</span></span><span class="default_value"><span
class="pre">True</span></span></em><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">→</span> [...]
+<span class="sig-name descname"><span
class="pre">large_list</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">value_type</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span [...]
<dd><p>Create a type representing a variable-size list of some other type.</p>
<p>Unlike <a class="reference internal" href="#nanoarrow.schema.list_"
title="nanoarrow.schema.list_"><code class="xref py py-func docutils literal
notranslate"><span class="pre">list_()</span></code></a>, the
func:<cite>large_list</cite> can accomodate arrays
with more than <code class="docutils literal notranslate"><span
class="pre">2</span> <span class="pre">**</span> <span class="pre">31</span>
<span class="pre">-</span> <span class="pre">1</span></code> items in the
values array.</p>
@@ -1264,7 +1277,7 @@ that uses 64-bit offsets.</p>
<dl class="py function">
<dt class="sig sig-object py" id="nanoarrow.schema.list_">
-<span class="sig-name descname"><span class="pre">list_</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">value_type</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">nullable</span></span><span class="o"><span
class="pre">=</span></span><span class="default_value"><span
class="pre">True</span></span></em><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">→</span> <spa [...]
+<span class="sig-name descname"><span class="pre">list_</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">value_type</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><spa [...]
<dd><p>Create a type representing a variable-size list of some other type.</p>
<section id="id51">
<h2>Parameters<a class="headerlink" href="#id51" title="Link to this
heading">#</a></h2>
@@ -1286,12 +1299,21 @@ that uses 64-bit offsets.</p>
</dd></dl>
<dl class="py function">
-<dt class="sig sig-object py" id="nanoarrow.schema.null">
-<span class="sig-name descname"><span class="pre">null</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-paren" [...]
-<dd><p>Create an instance of a null type.</p>
+<dt class="sig sig-object py" id="nanoarrow.schema.map_">
+<span class="sig-name descname"><span class="pre">map_</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">key_type</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">value_type</span></span></em>, <em
class="sig-param"><span class="n"><span
class="pre">keys_sorted</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w [...]
+<dd><p>Create a type representing a list of key/value mappings</p>
+<p>Note that each element in the list contains potentially many
+key/value pairs (and that a map array contains potentially
+many individual mappings).</p>
<section id="id53">
<h2>Parameters<a class="headerlink" href="#id53" title="Link to this
heading">#</a></h2>
<dl class="simple">
+<dt>value_type<span class="classifier">schema-like</span></dt><dd><p>The type
of keys in each map element.</p>
+</dd>
+<dt>value_type<span class="classifier">schema-like</span></dt><dd><p>The type
of values in each map element</p>
+</dd>
+<dt>keys_sorted<span class="classifier">bool, optional</span></dt><dd><p>True
if keys within each map element are sorted.</p>
+</dd>
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
@@ -1299,6 +1321,27 @@ that uses 64-bit offsets.</p>
<section id="id54">
<h2>Examples<a class="headerlink" href="#id54" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
+<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">map_</span><span class="p">(</span><span
class="n">na</span><span class="o">.</span><span class="n">int32</span><span
class="p">(),</span> <span class="n">na</span><span class="o">.</span><span
class="n">string</span><span class="p">())</span>
+<span class="go"><Schema> map<entries: struct<key: int32, value:
string>></span>
+</pre></div>
+</div>
+</section>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="nanoarrow.schema.null">
+<span class="sig-name descname"><span class="pre">null</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-paren" [...]
+<dd><p>Create an instance of a null type.</p>
+<section id="id55">
+<h2>Parameters<a class="headerlink" href="#id55" title="Link to this
heading">#</a></h2>
+<dl class="simple">
+<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
+</dd>
+</dl>
+</section>
+<section id="id56">
+<h2>Examples<a class="headerlink" href="#id56" title="Link to this
heading">#</a></h2>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">null</span><span class="p">()</span>
<span class="go"><Schema> na</span>
</pre></div>
@@ -1317,15 +1360,15 @@ that uses 64-bit offsets.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.string">
<span class="sig-name descname"><span class="pre">string</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-pare [...]
<dd><p>Create an instance of a variable-length UTF-8 encoded string type.</p>
-<section id="id55">
-<h2>Parameters<a class="headerlink" href="#id55" title="Link to this
heading">#</a></h2>
+<section id="id57">
+<h2>Parameters<a class="headerlink" href="#id57" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id56">
-<h2>Examples<a class="headerlink" href="#id56" title="Link to this
heading">#</a></h2>
+<section id="id58">
+<h2>Examples<a class="headerlink" href="#id58" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">string</span><span class="p">()</span>
<span class="go"><Schema> string</span>
@@ -1338,15 +1381,15 @@ that uses 64-bit offsets.</p>
<dt class="sig sig-object py" id="nanoarrow.schema.string_view">
<span class="sig-name descname"><span
class="pre">string_view</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span class="pre">nullable</span></span><span
class="p"><span class="pre">:</span></span><span class="w"> </span><span
class="n"><span class="pre">bool</span></span><span class="w"> </span><span
class="o"><span class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span class="sig
[...]
<dd><p>Create an instance of a string view type.</p>
-<section id="id57">
-<h2>Parameters<a class="headerlink" href="#id57" title="Link to this
heading">#</a></h2>
+<section id="id59">
+<h2>Parameters<a class="headerlink" href="#id59" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id58">
-<h2>Examples<a class="headerlink" href="#id58" title="Link to this
heading">#</a></h2>
+<section id="id60">
+<h2>Examples<a class="headerlink" href="#id60" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">string_view</span><span class="p">()</span>
<span class="go"><Schema> string_view</span>
@@ -1357,10 +1400,10 @@ that uses 64-bit offsets.</p>
<dl class="py function">
<dt class="sig sig-object py" id="nanoarrow.schema.struct">
-<span class="sig-name descname"><span class="pre">struct</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">fields</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">nullable</span></span><span class="o"><span
class="pre">=</span></span><span class="default_value"><span
class="pre">True</span></span></em><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">→</span> <span c [...]
+<span class="sig-name descname"><span class="pre">struct</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">fields</span></span></em>, <em class="sig-param"><span
class="n"><span class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span c [...]
<dd><p>Create a type representing a named sequence of fields.</p>
-<section id="id59">
-<h2>Parameters<a class="headerlink" href="#id59" title="Link to this
heading">#</a></h2>
+<section id="id61">
+<h2>Parameters<a class="headerlink" href="#id61" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>fields :</dt><dd><ul class="simple">
<li><p>A dictionary whose keys are field names and values are schema-like
objects</p></li>
@@ -1372,8 +1415,8 @@ inherited from the schema-like object.</p></li>
</dd>
</dl>
</section>
-<section id="id60">
-<h2>Examples<a class="headerlink" href="#id60" title="Link to this
heading">#</a></h2>
+<section id="id62">
+<h2>Examples<a class="headerlink" href="#id62" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">struct</span><span class="p">([</span><span
class="n">na</span><span class="o">.</span><span class="n">int32</span><span
class="p">()])</span>
<span class="go"><Schema> struct<: int32></span>
@@ -1388,8 +1431,8 @@ inherited from the schema-like object.</p></li>
<dt class="sig sig-object py" id="nanoarrow.schema.time32">
<span class="sig-name descname"><span class="pre">time32</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">unit</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><a class="reference
internal" href="#nanoarrow.schema.TimeUnit"
title="nanoarrow.schema.TimeUnit"><spa [...]
<dd><p>Create an instance of a 32-bit time of day type.</p>
-<section id="id61">
-<h2>Parameters<a class="headerlink" href="#id61" title="Link to this
heading">#</a></h2>
+<section id="id63">
+<h2>Parameters<a class="headerlink" href="#id63" title="Link to this
heading">#</a></h2>
<dl>
<dt>unit<span class="classifier">str or <a class="reference internal"
href="#nanoarrow.schema.TimeUnit" title="nanoarrow.schema.TimeUnit"><code
class="xref py py-class docutils literal notranslate"><span
class="pre">TimeUnit</span></code></a></span></dt><dd><p>The unit of values
stored by this type.</p>
</dd>
@@ -1397,8 +1440,8 @@ inherited from the schema-like object.</p></li>
</dd>
</dl>
</section>
-<section id="id62">
-<h2>Examples<a class="headerlink" href="#id62" title="Link to this
heading">#</a></h2>
+<section id="id64">
+<h2>Examples<a class="headerlink" href="#id64" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">time32</span><span class="p">(</span><span
class="s2">"s"</span><span class="p">)</span>
<span class="go"><Schema> time32('s')</span>
@@ -1411,8 +1454,8 @@ inherited from the schema-like object.</p></li>
<dt class="sig sig-object py" id="nanoarrow.schema.time64">
<span class="sig-name descname"><span class="pre">time64</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">unit</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><a class="reference
internal" href="#nanoarrow.schema.TimeUnit"
title="nanoarrow.schema.TimeUnit"><spa [...]
<dd><p>Create an instance of a 64-bit time of day type.</p>
-<section id="id63">
-<h2>Parameters<a class="headerlink" href="#id63" title="Link to this
heading">#</a></h2>
+<section id="id65">
+<h2>Parameters<a class="headerlink" href="#id65" title="Link to this
heading">#</a></h2>
<dl>
<dt>unit<span class="classifier">str or <a class="reference internal"
href="#nanoarrow.schema.TimeUnit" title="nanoarrow.schema.TimeUnit"><code
class="xref py py-class docutils literal notranslate"><span
class="pre">TimeUnit</span></code></a></span></dt><dd><p>The unit of values
stored by this type.</p>
</dd>
@@ -1420,8 +1463,8 @@ inherited from the schema-like object.</p></li>
</dd>
</dl>
</section>
-<section id="id64">
-<h2>Examples<a class="headerlink" href="#id64" title="Link to this
heading">#</a></h2>
+<section id="id66">
+<h2>Examples<a class="headerlink" href="#id66" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">time64</span><span class="p">(</span><span
class="s2">"us"</span><span class="p">)</span>
<span class="go"><Schema> time64('us')</span>
@@ -1434,8 +1477,8 @@ inherited from the schema-like object.</p></li>
<dt class="sig sig-object py" id="nanoarrow.schema.timestamp">
<span class="sig-name descname"><span class="pre">timestamp</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">unit</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span><span class="w"> </span><span class="p"><span
class="pre">|</span></span><span class="w"> </span><a class="reference
internal" href="#nanoarrow.schema.TimeUnit" title="nanoarrow.schema.TimeUnit"><
[...]
<dd><p>Create an instance of a timestamp type.</p>
-<section id="id65">
-<h2>Parameters<a class="headerlink" href="#id65" title="Link to this
heading">#</a></h2>
+<section id="id67">
+<h2>Parameters<a class="headerlink" href="#id67" title="Link to this
heading">#</a></h2>
<dl>
<dt>unit<span class="classifier">str or <a class="reference internal"
href="#nanoarrow.schema.TimeUnit" title="nanoarrow.schema.TimeUnit"><code
class="xref py py-class docutils literal notranslate"><span
class="pre">TimeUnit</span></code></a></span></dt><dd><p>The unit of values
stored by this type.</p>
</dd>
@@ -1443,8 +1486,8 @@ inherited from the schema-like object.</p></li>
</dd>
</dl>
</section>
-<section id="id66">
-<h2>Examples<a class="headerlink" href="#id66" title="Link to this
heading">#</a></h2>
+<section id="id68">
+<h2>Examples<a class="headerlink" href="#id68" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">timestamp</span><span class="p">(</span><span
class="s2">"s"</span><span class="p">)</span>
<span class="go"><Schema> timestamp('s', '')</span>
@@ -1459,15 +1502,15 @@ inherited from the schema-like object.</p></li>
<dt class="sig sig-object py" id="nanoarrow.schema.uint16">
<span class="sig-name descname"><span class="pre">uint16</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-pare [...]
<dd><p>Create an instance of an unsigned 16-bit integer type.</p>
-<section id="id67">
-<h2>Parameters<a class="headerlink" href="#id67" title="Link to this
heading">#</a></h2>
+<section id="id69">
+<h2>Parameters<a class="headerlink" href="#id69" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id68">
-<h2>Examples<a class="headerlink" href="#id68" title="Link to this
heading">#</a></h2>
+<section id="id70">
+<h2>Examples<a class="headerlink" href="#id70" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">uint16</span><span class="p">()</span>
<span class="go"><Schema> uint16</span>
@@ -1480,15 +1523,15 @@ inherited from the schema-like object.</p></li>
<dt class="sig sig-object py" id="nanoarrow.schema.uint32">
<span class="sig-name descname"><span class="pre">uint32</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-pare [...]
<dd><p>Create an instance of an unsigned 32-bit integer type.</p>
-<section id="id69">
-<h2>Parameters<a class="headerlink" href="#id69" title="Link to this
heading">#</a></h2>
+<section id="id71">
+<h2>Parameters<a class="headerlink" href="#id71" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id70">
-<h2>Examples<a class="headerlink" href="#id70" title="Link to this
heading">#</a></h2>
+<section id="id72">
+<h2>Examples<a class="headerlink" href="#id72" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">uint32</span><span class="p">()</span>
<span class="go"><Schema> uint32</span>
@@ -1501,15 +1544,15 @@ inherited from the schema-like object.</p></li>
<dt class="sig sig-object py" id="nanoarrow.schema.uint64">
<span class="sig-name descname"><span class="pre">uint64</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-pare [...]
<dd><p>Create an instance of an unsigned 32-bit integer type.</p>
-<section id="id71">
-<h2>Parameters<a class="headerlink" href="#id71" title="Link to this
heading">#</a></h2>
+<section id="id73">
+<h2>Parameters<a class="headerlink" href="#id73" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id72">
-<h2>Examples<a class="headerlink" href="#id72" title="Link to this
heading">#</a></h2>
+<section id="id74">
+<h2>Examples<a class="headerlink" href="#id74" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">uint64</span><span class="p">()</span>
<span class="go"><Schema> uint64</span>
@@ -1522,15 +1565,15 @@ inherited from the schema-like object.</p></li>
<dt class="sig sig-object py" id="nanoarrow.schema.uint8">
<span class="sig-name descname"><span class="pre">uint8</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">nullable</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">bool</span></span><span class="w"> </span><span class="o"><span
class="pre">=</span></span><span class="w"> </span><span
class="default_value"><span class="pre">True</span></span></em><span
class="sig-paren [...]
<dd><p>Create an instance of an unsigned 8-bit integer type.</p>
-<section id="id73">
-<h2>Parameters<a class="headerlink" href="#id73" title="Link to this
heading">#</a></h2>
+<section id="id75">
+<h2>Parameters<a class="headerlink" href="#id75" title="Link to this
heading">#</a></h2>
<dl class="simple">
<dt>nullable<span class="classifier">bool, optional</span></dt><dd><p>Use
<code class="docutils literal notranslate"><span
class="pre">False</span></code> to mark this field as non-nullable.</p>
</dd>
</dl>
</section>
-<section id="id74">
-<h2>Examples<a class="headerlink" href="#id74" title="Link to this
heading">#</a></h2>
+<section id="id76">
+<h2>Examples<a class="headerlink" href="#id76" title="Link to this
heading">#</a></h2>
<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="kn">import</span> <span class="nn">nanoarrow</span> <span
class="k">as</span> <span class="nn">na</span>
<span class="gp">>>> </span><span class="n">na</span><span
class="o">.</span><span class="n">uint8</span><span class="p">()</span>
<span class="go"><Schema> uint8</span>
@@ -1601,6 +1644,7 @@ inherited from the schema-like object.</p></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.Schema.field"><code class="docutils literal
notranslate"><span class="pre">Schema.field()</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.Schema.fields"><code class="docutils literal
notranslate"><span class="pre">Schema.fields</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.Schema.index_type"><code class="docutils literal
notranslate"><span class="pre">Schema.index_type</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.Schema.key_type"><code class="docutils literal
notranslate"><span class="pre">Schema.key_type</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.Schema.list_size"><code class="docutils literal
notranslate"><span class="pre">Schema.list_size</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.Schema.metadata"><code class="docutils literal
notranslate"><span class="pre">Schema.metadata</span></code></a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.Schema.n_fields"><code class="docutils literal
notranslate"><span class="pre">Schema.n_fields</span></code></a></li>
@@ -1647,6 +1691,7 @@ inherited from the schema-like object.</p></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.large_list"><code class="docutils literal
notranslate"><span class="pre">large_list()</span></code></a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.large_string"><code class="docutils literal
notranslate"><span class="pre">large_string()</span></code></a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.list_"><code class="docutils literal notranslate"><span
class="pre">list_()</span></code></a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.map_"><code class="docutils literal notranslate"><span
class="pre">map_()</span></code></a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.null"><code class="docutils literal notranslate"><span
class="pre">null()</span></code></a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.schema"><code class="docutils literal
notranslate"><span class="pre">schema()</span></code></a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link"
href="#nanoarrow.schema.string"><code class="docutils literal
notranslate"><span class="pre">string()</span></code></a></li>
diff --git a/main/searchindex.js b/main/searchindex.js
index c5169f6b..16f0061d 100644
--- a/main/searchindex.js
+++ b/main/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"API Reference": [[8, null]], "Array Stream
utilities": [[6, "array-stream-utilities"]], "Array Streams": [[3,
"array-streams"]], "Array streams": [[2, "array-streams"]], "Arrays": [[2,
"arrays"], [3, "arrays"]], "Arrow C Data Interface": [[5,
"arrow-c-data-interface"]], "Arrow C Device Interface": [[7,
"arrow-c-device-interface"]], "Arrow C data/nanoarrow interface basics": [[0,
"arrow-c-data-nanoarrow-interface-basics"]], "Bitmap utilities": [[5, "bitmap-
[...]
\ No newline at end of file
+Search.setIndex({"alltitles": {"API Reference": [[8, null]], "Array Stream
utilities": [[6, "array-stream-utilities"]], "Array Streams": [[3,
"array-streams"]], "Array streams": [[2, "array-streams"]], "Arrays": [[2,
"arrays"], [3, "arrays"]], "Arrow C Data Interface": [[5,
"arrow-c-data-interface"]], "Arrow C Device Interface": [[7,
"arrow-c-device-interface"]], "Arrow C data/nanoarrow interface basics": [[0,
"arrow-c-data-nanoarrow-interface-basics"]], "Bitmap utilities": [[5, "bitmap-
[...]
\ No newline at end of file