deploy: b073454

jorgecarleitao · Oct 24, 2023 · 8a96daf · 8a96daf
1 parent be4706d
commit 8a96daf
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 5 deletions.
diff --git a/main/docs/arrow2/all.html b/main/docs/arrow2/all.html
diff --git a/main/docs/arrow2/io/parquet/read/deserialize/fn.nested_column_iter_to_arrays.html b/main/docs/arrow2/io/parquet/read/deserialize/fn.nested_column_iter_to_arrays.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta http-equiv="refresh" content="0;URL=../../../../../arrow2/io/parquet/read/fn.nested_column_iter_to_arrays.html">
+    <title>Redirection</title>
+</head>
+<body>
+    <p>Redirecting to <a href="../../../../../arrow2/io/parquet/read/fn.nested_column_iter_to_arrays.html">../../../../../arrow2/io/parquet/read/fn.nested_column_iter_to_arrays.html</a>...</p>
+    <script>location.replace("../../../../../arrow2/io/parquet/read/fn.nested_column_iter_to_arrays.html" + location.search + location.hash);</script>
+</body>
+</html>
diff --git a/main/docs/arrow2/io/parquet/read/fn.nested_column_iter_to_arrays.html b/main/docs/arrow2/io/parquet/read/fn.nested_column_iter_to_arrays.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Basically the same as `column_iter_to_arrays`, with the addition of the `init` parameter to read the inner columns of the nested type directly, instead of reading the entire nested type."><title>nested_column_iter_to_arrays in arrow2::io::parquet::read - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../../static.files/rustdoc-9ee3a5e31a2afa3e.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="arrow2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0-nightly (cd674d617 2023-10-24)" data-channel="nightly" data-search-js="search-8fbf244ebcf71464.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../../static.files/main-5f34af1a0ee6bacd.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../arrow2/index.html">arrow2</a><span class="version">0.17.4</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In arrow2::io::parquet::read</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../../../index.html">arrow2</a>::<wbr><a href="../../index.html">io</a>::<wbr><a href="../index.html">parquet</a>::<wbr><a href="index.html">read</a>::<wbr><a class="fn" href="#">nested_column_iter_to_arrays</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../../../src/arrow2/io/parquet/read/deserialize/mod.rs.html#220-235">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn nested_column_iter_to_arrays&lt;'a, I&gt;(
+    columns: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;I&gt;,
+    types: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;&amp;PrimitiveType&gt;,
+    field: <a class="struct" href="../../../datatypes/struct.Field.html" title="struct arrow2::datatypes::Field">Field</a>,
+    init: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="enum" href="enum.InitNested.html" title="enum arrow2::io::parquet::read::InitNested">InitNested</a>&gt;,
+    chunk_size: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;,
+    num_rows: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>
+) -&gt; <a class="type" href="../../../error/type.Result.html" title="type arrow2::error::Result">Result</a>&lt;<a class="type" href="type.ArrayIter.html" title="type arrow2::io::parquet::read::ArrayIter">ArrayIter</a>&lt;'a&gt;&gt;<span class="where fmt-newline">where
+    I: <a class="trait" href="trait.Pages.html" title="trait arrow2::io::parquet::read::Pages">Pages</a> + 'a,</span></code></pre><span class="item-info"><div class="stab portability">Available on <strong>crate feature <code>io_parquet</code></strong> only.</div></span><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Basically the same as <code>column_iter_to_arrays</code>, with the addition of the <code>init</code> parameter
+to read the inner columns of the nested type directly, instead of reading the entire nested type.</p>
+</div></details></section></div></main></body></html>
diff --git a/main/docs/arrow2/io/parquet/read/index.html b/main/docs/arrow2/io/parquet/read/index.html
@@ -14,7 +14,8 @@
 If <code>page.buffer.len() == 0</code>, there was no decompression and the buffer was moved.
 Else, decompression took place.</div></li><li><div class="item-name"><a class="fn" href="fn.get_column_iterator.html" title="fn arrow2::io::parquet::read::get_column_iterator">get_column_iterator</a></div><div class="desc docblock-short">Returns a [<code>ColumnIterator</code>] of column chunks corresponding to <code>field</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.get_field_columns.html" title="fn arrow2::io::parquet::read::get_field_columns">get_field_columns</a></div><div class="desc docblock-short">Returns all <a href="struct.ColumnChunkMetaData.html" title="struct arrow2::io::parquet::read::ColumnChunkMetaData"><code>ColumnChunkMetaData</code></a> associated to <code>field_name</code>.
 For non-nested parquet types, this returns a single column</div></li><li><div class="item-name"><a class="fn" href="fn.get_field_pages.html" title="fn arrow2::io::parquet::read::get_field_pages">get_field_pages</a></div><div class="desc docblock-short">Returns all <a href="struct.ColumnChunkMetaData.html" title="struct arrow2::io::parquet::read::ColumnChunkMetaData"><code>ColumnChunkMetaData</code></a> associated to <code>field_name</code>.
-For non-nested parquet types, this returns a single column</div></li><li><div class="item-name"><a class="fn" href="fn.get_page_iterator.html" title="fn arrow2::io::parquet::read::get_page_iterator">get_page_iterator</a></div><div class="desc docblock-short">Creates a new iterator of compressed pages.</div></li><li><div class="item-name"><a class="fn" href="fn.get_page_stream.html" title="fn arrow2::io::parquet::read::get_page_stream">get_page_stream</a></div><div class="desc docblock-short">Returns a stream of compressed data pages</div></li><li><div class="item-name"><a class="fn" href="fn.init_nested.html" title="fn arrow2::io::parquet::read::init_nested">init_nested</a></div><div class="desc docblock-short">Initialize <a href="struct.NestedState.html" title="struct arrow2::io::parquet::read::NestedState"><code>NestedState</code></a> from <code>&amp;[InitNested]</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.int96_to_i64_ns.html" title="fn arrow2::io::parquet::read::int96_to_i64_ns">int96_to_i64_ns</a></div></li><li><div class="item-name"><a class="fn" href="fn.n_columns.html" title="fn arrow2::io::parquet::read::n_columns">n_columns</a></div><div class="desc docblock-short">Returns the number of (parquet) columns that a <a href="../../../datatypes/enum.DataType.html" title="enum arrow2::datatypes::DataType"><code>DataType</code></a> contains.</div></li><li><div class="item-name"><a class="fn" href="fn.read_columns.html" title="fn arrow2::io::parquet::read::read_columns">read_columns</a></div><div class="desc docblock-short">Reads all columns that are part of the parquet field <code>field_name</code></div></li><li><div class="item-name"><a class="fn" href="fn.read_columns_async.html" title="fn arrow2::io::parquet::read::read_columns_async">read_columns_async</a></div><div class="desc docblock-short">Reads all columns that are part of the parquet field <code>field_name</code></div></li><li><div class="item-name"><a class="fn" href="fn.read_columns_many.html" title="fn arrow2::io::parquet::read::read_columns_many">read_columns_many</a></div><div class="desc docblock-short">Returns a vector of iterators of <a href="../../../array/trait.Array.html" title="trait arrow2::array::Array"><code>Array</code></a> (<a href="type.ArrayIter.html" title="type arrow2::io::parquet::read::ArrayIter"><code>ArrayIter</code></a>) corresponding to the top
+For non-nested parquet types, this returns a single column</div></li><li><div class="item-name"><a class="fn" href="fn.get_page_iterator.html" title="fn arrow2::io::parquet::read::get_page_iterator">get_page_iterator</a></div><div class="desc docblock-short">Creates a new iterator of compressed pages.</div></li><li><div class="item-name"><a class="fn" href="fn.get_page_stream.html" title="fn arrow2::io::parquet::read::get_page_stream">get_page_stream</a></div><div class="desc docblock-short">Returns a stream of compressed data pages</div></li><li><div class="item-name"><a class="fn" href="fn.init_nested.html" title="fn arrow2::io::parquet::read::init_nested">init_nested</a></div><div class="desc docblock-short">Initialize <a href="struct.NestedState.html" title="struct arrow2::io::parquet::read::NestedState"><code>NestedState</code></a> from <code>&amp;[InitNested]</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.int96_to_i64_ns.html" title="fn arrow2::io::parquet::read::int96_to_i64_ns">int96_to_i64_ns</a></div></li><li><div class="item-name"><a class="fn" href="fn.n_columns.html" title="fn arrow2::io::parquet::read::n_columns">n_columns</a></div><div class="desc docblock-short">Returns the number of (parquet) columns that a <a href="../../../datatypes/enum.DataType.html" title="enum arrow2::datatypes::DataType"><code>DataType</code></a> contains.</div></li><li><div class="item-name"><a class="fn" href="fn.nested_column_iter_to_arrays.html" title="fn arrow2::io::parquet::read::nested_column_iter_to_arrays">nested_column_iter_to_arrays</a></div><div class="desc docblock-short">Basically the same as <code>column_iter_to_arrays</code>, with the addition of the <code>init</code> parameter
+to read the inner columns of the nested type directly, instead of reading the entire nested type.</div></li><li><div class="item-name"><a class="fn" href="fn.read_columns.html" title="fn arrow2::io::parquet::read::read_columns">read_columns</a></div><div class="desc docblock-short">Reads all columns that are part of the parquet field <code>field_name</code></div></li><li><div class="item-name"><a class="fn" href="fn.read_columns_async.html" title="fn arrow2::io::parquet::read::read_columns_async">read_columns_async</a></div><div class="desc docblock-short">Reads all columns that are part of the parquet field <code>field_name</code></div></li><li><div class="item-name"><a class="fn" href="fn.read_columns_many.html" title="fn arrow2::io::parquet::read::read_columns_many">read_columns_many</a></div><div class="desc docblock-short">Returns a vector of iterators of <a href="../../../array/trait.Array.html" title="trait arrow2::array::Array"><code>Array</code></a> (<a href="type.ArrayIter.html" title="type arrow2::io::parquet::read::ArrayIter"><code>ArrayIter</code></a>) corresponding to the top
 level parquet fields whose name matches <code>fields</code>’s names.</div></li><li><div class="item-name"><a class="fn" href="fn.read_columns_many_async.html" title="fn arrow2::io::parquet::read::read_columns_many_async">read_columns_many_async</a></div><div class="desc docblock-short">Returns a vector of iterators of <a href="../../../array/trait.Array.html" title="trait arrow2::array::Array"><code>Array</code></a> corresponding to the top level parquet fields whose
 name matches <code>fields</code>’s names.</div></li><li><div class="item-name"><a class="fn" href="fn.read_metadata.html" title="fn arrow2::io::parquet::read::read_metadata">read_metadata</a></div><div class="desc docblock-short">Reads parquets’ metadata syncronously.</div></li><li><div class="item-name"><a class="fn" href="fn.read_metadata_async.html" title="fn arrow2::io::parquet::read::read_metadata_async">read_metadata_async</a></div><div class="desc docblock-short">Reads parquets’ metadata asynchronously.</div></li><li><div class="item-name"><a class="fn" href="fn.read_pages_locations.html" title="fn arrow2::io::parquet::read::read_pages_locations">read_pages_locations</a></div><div class="desc docblock-short">Read [<code>PageLocation</code>]s from the <a href="struct.ColumnChunkMetaData.html" title="struct arrow2::io::parquet::read::ColumnChunkMetaData"><code>ColumnChunkMetaData</code></a>s.
 Returns an empty vector if indexes are not available</div></li><li><div class="item-name"><a class="fn" href="fn.to_deserializer.html" title="fn arrow2::io::parquet::read::to_deserializer">to_deserializer</a></div><div class="desc docblock-short">Converts a vector of columns associated with the parquet field whose name is <a href="../../../datatypes/struct.Field.html" title="struct arrow2::datatypes::Field"><code>Field</code></a>

diff --git a/main/docs/arrow2/io/parquet/read/sidebar-items.js b/main/docs/arrow2/io/parquet/read/sidebar-items.js
diff --git a/main/docs/search-index.js b/main/docs/search-index.js
diff --git a/main/docs/src/arrow2/io/parquet/read/deserialize/mod.rs.html b/main/docs/src/arrow2/io/parquet/read/deserialize/mod.rs.html
@@ -214,6 +214,25 @@
 <a href="#214" id="214">214</a>
 <a href="#215" id="215">215</a>
 <a href="#216" id="216">216</a>
+<a href="#217" id="217">217</a>
+<a href="#218" id="218">218</a>
+<a href="#219" id="219">219</a>
+<a href="#220" id="220">220</a>
+<a href="#221" id="221">221</a>
+<a href="#222" id="222">222</a>
+<a href="#223" id="223">223</a>
+<a href="#224" id="224">224</a>
+<a href="#225" id="225">225</a>
+<a href="#226" id="226">226</a>
+<a href="#227" id="227">227</a>
+<a href="#228" id="228">228</a>
+<a href="#229" id="229">229</a>
+<a href="#230" id="230">230</a>
+<a href="#231" id="231">231</a>
+<a href="#232" id="232">232</a>
+<a href="#233" id="233">233</a>
+<a href="#234" id="234">234</a>
+<a href="#235" id="235">235</a>
 </pre></div><pre class="rust"><code><span class="doccomment">//! APIs to read from Parquet format.
 </span><span class="kw">mod </span>binary;
 <span class="kw">mod </span>boolean;
@@ -430,4 +449,23 @@
             </span>.map(|x| x.map(|x| x.<span class="number">1</span>)),
     ))
 }
+
+<span class="doccomment">/// Basically the same as `column_iter_to_arrays`, with the addition of the `init` parameter
+/// to read the inner columns of the nested type directly, instead of reading the entire nested type.
+</span><span class="kw">pub fn </span>nested_column_iter_to_arrays&lt;<span class="lifetime">&#39;a</span>, I: <span class="lifetime">&#39;a</span>&gt;(
+    columns: Vec&lt;I&gt;,
+    types: Vec&lt;<span class="kw-2">&amp;</span>PrimitiveType&gt;,
+    field: Field,
+    init: Vec&lt;InitNested&gt;,
+    chunk_size: <span class="prelude-ty">Option</span>&lt;usize&gt;,
+    num_rows: usize,
+) -&gt; <span class="prelude-ty">Result</span>&lt;ArrayIter&lt;<span class="lifetime">&#39;a</span>&gt;&gt;
+<span class="kw">where
+    </span>I: Pages,
+{
+    <span class="prelude-val">Ok</span>(Box::new(
+        nested::columns_to_iter_recursive(columns, types, field, init, num_rows, chunk_size)<span class="question-mark">?
+            </span>.map(|x| x.map(|x| x.<span class="number">1</span>)),
+    ))
+}
 </code></pre></div></section></main></body></html>
diff --git a/main/docs/src/arrow2/io/parquet/read/mod.rs.html b/main/docs/src/arrow2/io/parquet/read/mod.rs.html
@@ -133,7 +133,7 @@
 <span class="kw">use </span><span class="kw">crate</span>::types::{i256, NativeType};
 <span class="kw">pub use </span>deserialize::{
     column_iter_to_arrays, create_list, create_map, get_page_iterator, init_nested, n_columns,
-    InitNested, NestedArrayIter, NestedState, StructIterator,
+    nested_column_iter_to_arrays, InitNested, NestedArrayIter, NestedState, StructIterator,
 };
 <span class="kw">pub use </span>file::{FileReader, RowGroupReader};
 <span class="kw">pub use </span>row_group::<span class="kw-2">*</span>;