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-rs.git
The following commit(s) were added to refs/heads/asf-site by this push:
new b5c8d986a2 deploy: d9719d1f2d21ed0c75ffd5c8e8c4fb15ee5ebe54
b5c8d986a2 is described below
commit b5c8d986a232a0496205f160ce9cafd31762fd26
Author: tustvold <[email protected]>
AuthorDate: Sat Jul 22 16:35:19 2023 +0000
deploy: d9719d1f2d21ed0c75ffd5c8e8c4fb15ee5ebe54
---
arrow/datatypes/struct.Field.html | 41 +++++++++++++++----------------
arrow_schema/field/index.html | 2 +-
arrow_schema/field/struct.Field.html | 47 ++++++++++++++++++------------------
arrow_schema/struct.Field.html | 47 ++++++++++++++++++------------------
src/arrow_schema/field.rs.html | 6 +----
5 files changed, 68 insertions(+), 75 deletions(-)
diff --git a/arrow/datatypes/struct.Field.html
b/arrow/datatypes/struct.Field.html
index b1f80e9550..1725235113 100644
--- a/arrow/datatypes/struct.Field.html
+++ b/arrow/datatypes/struct.Field.html
@@ -35,11 +35,11 @@
nullable: <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a>
) -> <a class="struct" href="struct.Field.html" title="struct
arrow::datatypes::Field">Field</a></h4></section></summary><div
class="docblock"><p>Create a new <a href="struct.Field.html" title="struct
arrow::datatypes::Field"><code>Field</code></a> with <a
href="enum.DataType.html#variant.Struct" title="variant
arrow::datatypes::DataType::Struct"><code>DataType::Struct</code></a></p>
<ul>
-<li><code>name</code>: the name of the <a
href="enum.DataType.html#variant.List" title="variant
arrow::datatypes::DataType::List"><code>DataType::List</code></a> field</li>
+<li><code>name</code>: the name of the <a
href="enum.DataType.html#variant.Struct" title="variant
arrow::datatypes::DataType::Struct"><code>DataType::Struct</code></a> field</li>
<li><code>fields</code>: the description of each struct element</li>
<li><code>nullable</code>: if the <a href="enum.DataType.html#variant.Struct"
title="variant
arrow::datatypes::DataType::Struct"><code>DataType::Struct</code></a> array is
nullable</li>
</ul>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_list" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#191-195">source</a><h4
class="code-header">pub fn <a href="#method.new_list" class="fn">new_list</a>(
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_list" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#189-193">source</a><h4
class="code-header">pub fn <a href="#method.new_list" class="fn">new_list</a>(
name: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a>>,
value: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html";
title="struct alloc::sync::Arc">Arc</a><<a class="struct"
href="struct.Field.html" title="struct arrow::datatypes::Field">Field</a>, <a
class="struct"
href="https://doc.rust-lang.org/nightly/alloc/alloc/struct.Global.html";
title="struct alloc::alloc::Glo [...]
nullable: <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a>
@@ -49,8 +49,7 @@
<li><code>value</code>: the description of each list element</li>
<li><code>nullable</code>: if the <a href="enum.DataType.html#variant.List"
title="variant
arrow::datatypes::DataType::List"><code>DataType::List</code></a> array is
nullable</li>
</ul>
-<p>Uses “item” as the name of the child field, this can be overridden with <a
href="struct.Field.html#method.new" title="associated function
arrow::datatypes::Field::new"><code>Self::new</code></a></p>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_large_list" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#204-208">source</a><h4
class="code-header">pub fn <a href="#method.new_large_list"
class="fn">new_large_list</a>(
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_large_list" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#202-206">source</a><h4
class="code-header">pub fn <a href="#method.new_large_list"
class="fn">new_large_list</a>(
name: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a>>,
value: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html";
title="struct alloc::sync::Arc">Arc</a><<a class="struct"
href="struct.Field.html" title="struct arrow::datatypes::Field">Field</a>, <a
class="struct"
href="https://doc.rust-lang.org/nightly/alloc/alloc/struct.Global.html";
title="struct alloc::alloc::Glo [...]
nullable: <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a>
@@ -60,7 +59,7 @@
<li><code>value</code>: the description of each list element</li>
<li><code>nullable</code>: if the <a
href="enum.DataType.html#variant.LargeList" title="variant
arrow::datatypes::DataType::LargeList"><code>DataType::LargeList</code></a>
array is nullable</li>
</ul>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_map" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#220-227">source</a><h4
class="code-header">pub fn <a href="#method.new_map" class="fn">new_map</a>(
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_map" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#218-225">source</a><h4
class="code-header">pub fn <a href="#method.new_map" class="fn">new_map</a>(
name: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a>>,
entries: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a>>,
keys: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html";
title="struct alloc::sync::Arc">Arc</a><<a class="struct"
href="struct.Field.html" title="struct arrow::datatypes::Field">Field</a>, <a
class="struct"
href="https://doc.rust-lang.org/nightly/alloc/alloc/struct.Global.html";
title="struct alloc::alloc::Glob [...]
@@ -76,7 +75,7 @@
<li><code>sorted</code>: if the <a href="enum.DataType.html#variant.Map"
title="variant arrow::datatypes::DataType::Map"><code>DataType::Map</code></a>
array is sorted</li>
<li><code>nullable</code>: if the <a href="enum.DataType.html#variant.Map"
title="variant arrow::datatypes::DataType::Map"><code>DataType::Map</code></a>
array is nullable</li>
</ul>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_union" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#245-250">source</a><h4
class="code-header">pub fn <a href="#method.new_union"
class="fn">new_union</a><S, F, T>(
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_union" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#243-248">source</a><h4
class="code-header">pub fn <a href="#method.new_union"
class="fn">new_union</a><S, F, T>(
name: S,
type_ids: T,
fields: F,
@@ -92,36 +91,36 @@
<li><code>fields</code>: the union fields</li>
<li><code>mode</code>: the union mode</li>
</ul>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.set_metadata" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#261">source</a><h4
class="code-header">pub fn <a href="#method.set_metadata"
class="fn">set_metadata</a>(&mut self, metadata: <a class="struct"
href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html";
title="struct std::collections::hash::map::HashMap">HashMap</a><<a cla [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_metadata" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#266">source</a><h4
class="code-header">pub fn <a href="#method.with_metadata"
class="fn">with_metadata</a>(
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.set_metadata" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#259">source</a><h4
class="code-header">pub fn <a href="#method.set_metadata"
class="fn">set_metadata</a>(&mut self, metadata: <a class="struct"
href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html";
title="struct std::collections::hash::map::HashMap">HashMap</a><<a cla [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_metadata" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#264">source</a><h4
class="code-header">pub fn <a href="#method.with_metadata"
class="fn">with_metadata</a>(
self,
metadata: <a class="struct"
href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html";
title="struct std::collections::hash::map::HashMap">HashMap</a><<a
class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a>, <a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a>, <a class="struct" href="htt
[...]
) -> <a class="struct" href="struct.Field.html" title="struct
arrow::datatypes::Field">Field</a></h4></section></summary><div
class="docblock"><p>Sets the metadata of this <code>Field</code> to be
<code>metadata</code> and returns self</p>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.metadata" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#273">source</a><h4
class="code-header">pub const fn <a href="#method.metadata"
class="fn">metadata</a>(&self) -> &<a class="struct"
href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html";
title="struct std::collections::hash::map::HashMap">HashMap</a><<a
class="struc [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.name" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#279">source</a><h4
class="code-header">pub const fn <a href="#method.name"
class="fn">name</a>(&self) -> &<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a></h4></section></summary><div
class="docblock"><p>Returns an [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_name" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#292">source</a><h4
class="code-header">pub fn <a href="#method.with_name"
class="fn">with_name</a>(self, name: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/all [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.metadata" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#271">source</a><h4
class="code-header">pub const fn <a href="#method.metadata"
class="fn">metadata</a>(&self) -> &<a class="struct"
href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html";
title="struct std::collections::hash::map::HashMap">HashMap</a><<a
class="struc [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.name" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#277">source</a><h4
class="code-header">pub const fn <a href="#method.name"
class="fn">name</a>(&self) -> &<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a></h4></section></summary><div
class="docblock"><p>Returns an [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_name" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#290">source</a><h4
class="code-header">pub fn <a href="#method.with_name"
class="fn">with_name</a>(self, name: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/all [...]
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span
class="kw">let </span>field = Field::new(<span
class="string">"c1"</span>, DataType::Int64, <span
class="bool-val">false</span>)
.with_name(<span class="string">"c2"</span>);
<span class="macro">assert_eq!</span>(field.name(), <span
class="string">"c2"</span>);</code></pre></div>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.data_type" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#299">source</a><h4
class="code-header">pub const fn <a href="#method.data_type"
class="fn">data_type</a>(&self) -> &<a class="enum"
href="enum.DataType.html" title="enum
arrow::datatypes::DataType">DataType</a></h4></section></summary><div
class="docblock"><p>Returns an immutable reference to the < [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_data_type" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#312">source</a><h4
class="code-header">pub fn <a href="#method.with_data_type"
class="fn">with_data_type</a>(self, data_type: <a class="enum"
href="enum.DataType.html" title="enum arrow::datatypes::DataType">DataType</a>)
-> <a class="struct" href="struct.Field.html" title="struct
arrow::datatypes::Fi [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.data_type" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#297">source</a><h4
class="code-header">pub const fn <a href="#method.data_type"
class="fn">data_type</a>(&self) -> &<a class="enum"
href="enum.DataType.html" title="enum
arrow::datatypes::DataType">DataType</a></h4></section></summary><div
class="docblock"><p>Returns an immutable reference to the < [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_data_type" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#310">source</a><h4
class="code-header">pub fn <a href="#method.with_data_type"
class="fn">with_data_type</a>(self, data_type: <a class="enum"
href="enum.DataType.html" title="enum arrow::datatypes::DataType">DataType</a>)
-> <a class="struct" href="struct.Field.html" title="struct
arrow::datatypes::Fi [...]
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span
class="kw">let </span>field = Field::new(<span
class="string">"c1"</span>, DataType::Int64, <span
class="bool-val">false</span>)
.with_data_type(DataType::Utf8);
<span class="macro">assert_eq!</span>(field.data_type(), <span
class="kw-2">&</span>DataType::Utf8);</code></pre></div>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.is_nullable" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#319">source</a><h4
class="code-header">pub const fn <a href="#method.is_nullable"
class="fn">is_nullable</a>(&self) -> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a></h4></section></summary><div
class="docblock"><p>Indicates whether this <a href="struct [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_nullable" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#332">source</a><h4
class="code-header">pub fn <a href="#method.with_nullable"
class="fn">with_nullable</a>(self, nullable: <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a>)
-> <a class="struct" href="struct.Field.html" title="struct
arrow::datatypes::Field" [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.is_nullable" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#317">source</a><h4
class="code-header">pub const fn <a href="#method.is_nullable"
class="fn">is_nullable</a>(&self) -> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a></h4></section></summary><div
class="docblock"><p>Indicates whether this <a href="struct [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_nullable" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#330">source</a><h4
class="code-header">pub fn <a href="#method.with_nullable"
class="fn">with_nullable</a>(self, nullable: <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a>)
-> <a class="struct" href="struct.Field.html" title="struct
arrow::datatypes::Field" [...]
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span
class="kw">let </span>field = Field::new(<span
class="string">"c1"</span>, DataType::Int64, <span
class="bool-val">false</span>)
.with_nullable(<span class="bool-val">true</span>);
<span class="macro">assert_eq!</span>(field.is_nullable(), <span
class="bool-val">true</span>);</code></pre></div>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.dict_id" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#376">source</a><h4
class="code-header">pub const fn <a href="#method.dict_id"
class="fn">dict_id</a>(&self) -> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html";
title="enum core::option::Option">Option</a><<a class="primitive"
href="https://doc.rust-lang.org/nightly [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.dict_is_ordered" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#385">source</a><h4
class="code-header">pub const fn <a href="#method.dict_is_ordered"
class="fn">dict_is_ordered</a>(&self) -> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html";
title="enum core::option::Option">Option</a><<a class="primitive"
href="https://d [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.try_merge" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#406">source</a><h4
class="code-header">pub fn <a href="#method.try_merge"
class="fn">try_merge</a>(&mut self, from: &<a class="struct"
href="struct.Field.html" title="struct arrow::datatypes::Field">Field</a>)
-> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"; [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.dict_id" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#374">source</a><h4
class="code-header">pub const fn <a href="#method.dict_id"
class="fn">dict_id</a>(&self) -> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html";
title="enum core::option::Option">Option</a><<a class="primitive"
href="https://doc.rust-lang.org/nightly [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.dict_is_ordered" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#383">source</a><h4
class="code-header">pub const fn <a href="#method.dict_is_ordered"
class="fn">dict_is_ordered</a>(&self) -> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html";
title="enum core::option::Option">Option</a><<a class="primitive"
href="https://d [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.try_merge" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#404">source</a><h4
class="code-header">pub fn <a href="#method.try_merge"
class="fn">try_merge</a>(&mut self, from: &<a class="struct"
href="struct.Field.html" title="struct arrow::datatypes::Field">Field</a>)
-> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"; [...]
<p>Struct fields are merged recursively.</p>
<p>NOTE: <code>self</code> may be updated to a partial / unexpected state in
case of merge failure.</p>
<p>Example:</p>
@@ -129,18 +128,18 @@
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span
class="kw">let </span><span class="kw-2">mut </span>field = Field::new(<span
class="string">"c1"</span>, DataType::Int64, <span
class="bool-val">false</span>);
<span class="macro">assert!</span>(field.try_merge(<span
class="kw-2">&</span>Field::new(<span class="string">"c1"</span>,
DataType::Int64, <span class="bool-val">true</span>)).is_ok());
<span class="macro">assert!</span>(field.is_nullable());</code></pre></div>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.contains" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#517">source</a><h4
class="code-header">pub fn <a href="#method.contains"
class="fn">contains</a>(&self, other: &<a class="struct"
href="struct.Field.html" title="struct arrow::datatypes::Field">Field</a>)
-> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</ [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.contains" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#515">source</a><h4
class="code-header">pub fn <a href="#method.contains"
class="fn">contains</a>(&self, other: &<a class="struct"
href="struct.Field.html" title="struct arrow::datatypes::Field">Field</a>)
-> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</ [...]
<ul>
<li>if nullability doesn’t match, self needs to be nullable</li>
<li>self.metadata is a superset of other.metadata</li>
<li>all other fields are equal</li>
</ul>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.size" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#533">source</a><h4
class="code-header">pub fn <a href="#method.size"
class="fn">size</a>(&self) -> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.usize.html";>usize</a></h4></section></summary><div
class="docblock"><p>Return size of this instance in bytes.</p>
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.size" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#531">source</a><h4
class="code-header">pub fn <a href="#method.size"
class="fn">size</a>(&self) -> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.usize.html";>usize</a></h4></section></summary><div
class="docblock"><p>Return size of this instance in bytes.</p>
<p>Includes the size of <code>Self</code>.</p>
</div></details></div></details></div><h2 id="trait-implementations"
class="small-section-header">Trait Implementations<a
href="#trait-implementations" class="anchor">§</a></h2><div
id="trait-implementations-list"><details class="toggle implementors-toggle"
open><summary><section id="impl-Clone-for-Field" class="impl"><a class="src
rightside" href="../../src/arrow_schema/field.rs.html#35">source</a><a
href="#impl-Clone-for-Field" class="anchor">§</a><h3 class="code-header">impl
<a class= [...]
__deserializer: __D
) -> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html";
title="enum core::result::Result">Result</a><<a class="struct"
href="struct.Field.html" title="struct arrow::datatypes::Field">Field</a>,
<__D as <a class="trait"
href="https://docs.rs/serde/1.0.174/serde/de/trait.Deserializer.html";
title="trait serde::de::Deserializer">Deserializer</a><'de>>::<a
class="associatedtype"
href="https://docs.rs/serde/1.0.174/serde/de/trait.Deserialize [...]
- __D: <a class="trait"
href="https://docs.rs/serde/1.0.174/serde/de/trait.Deserializer.html";
title="trait
serde::de::Deserializer">Deserializer</a><'de>,</span></h4></section></summary><div
class='docblock'>Deserialize this value from the given Serde deserializer. <a
href="https://docs.rs/serde/1.0.174/serde/de/trait.Deserialize.html#tymethod.deserialize";>Read
more</a></div></details></div></details><details class="toggle
implementors-toggle" open><summary><section id="impl-Disp [...]
+ __D: <a class="trait"
href="https://docs.rs/serde/1.0.174/serde/de/trait.Deserializer.html";
title="trait
serde::de::Deserializer">Deserializer</a><'de>,</span></h4></section></summary><div
class='docblock'>Deserialize this value from the given Serde deserializer. <a
href="https://docs.rs/serde/1.0.174/serde/de/trait.Deserialize.html#tymethod.deserialize";>Read
more</a></div></details></div></details><details class="toggle
implementors-toggle" open><summary><section id="impl-Disp [...]
T: <a class="trait"
href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html";
title="trait
core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = <a
class="struct" href="struct.Field.html" title="struct
arrow::datatypes::Field">Field</a>>,</span></h4></section></summary><div
class='docblock'>Extends a collection with the contents of an iterator. <a
href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html#tyme
[...]
</div><div class="impl-items"><details class="toggle method-toggle"
open><summary><section id="method.from" class="method trait-impl"><a class="src
rightside" href="../../src/arrow_ipc/convert.rs.html#84">source</a><a
href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a
href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from";
class="fn">from</a>(field: <a class="struct"
href="../../arrow_ipc/gen/Schema/struct.Field.html" title="struct arrow_ipc
[...]
T: <a class="trait"
href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html";
title="trait
core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = <a
class="struct" href="struct.Field.html" title="struct
arrow::datatypes::Field">Field</a>>,</span></h4></section></summary><div
class='docblock'>Creates a value from an iterator. <a
href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.FromIterator.html#tymethod.from_iter";
[...]
diff --git a/arrow_schema/field/index.html b/arrow_schema/field/index.html
index 28cd01ca81..6e5652e364 100644
--- a/arrow_schema/field/index.html
+++ b/arrow_schema/field/index.html
@@ -1 +1 @@
-<!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="API
documentation for the Rust `field` mod in crate
`arrow_schema`."><title>arrow_schema::field - 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/wof [...]
\ No newline at end of file
+<!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="API
documentation for the Rust `field` mod in crate
`arrow_schema`."><title>arrow_schema::field - 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/wof [...]
\ No newline at end of file
diff --git a/arrow_schema/field/struct.Field.html
b/arrow_schema/field/struct.Field.html
index e6482a104f..ec605b1692 100644
--- a/arrow_schema/field/struct.Field.html
+++ b/arrow_schema/field/struct.Field.html
@@ -9,7 +9,7 @@
<p>A <a href="../schema/struct.Schema.html" title="struct
arrow_schema::schema::Schema"><code>Schema</code></a> is an ordered collection
of
<a href="struct.Field.html" title="struct
arrow_schema::field::Field"><code>Field</code></a> objects.</p>
</div></details><h2 id="fields" class="fields small-section-header">Fields<a
href="#fields" class="anchor">§</a></h2><span id="structfield.name"
class="structfield small-section-header"><a href="#structfield.name"
class="anchor field">§</a><code>name: <a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a></code></span><span
id="structfield.data_type" class="structfield small-section-header"><a
href="#stru [...]
-</div><h2 id="implementations" class="small-section-header">Implementations<a
href="#implementations" class="anchor">§</a></h2><div
id="implementations-list"><details class="toggle implementors-toggle"
open><summary><section id="impl-Field" class="impl"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#119-544">source</a><a
href="#impl-Field" class="anchor">§</a><h3 class="code-header">impl <a
class="struct" href="struct.Field.html" title="struct arrow_schema::field::Fi
[...]
+</div><h2 id="implementations" class="small-section-header">Implementations<a
href="#implementations" class="anchor">§</a></h2><div
id="implementations-list"><details class="toggle implementors-toggle"
open><summary><section id="impl-Field" class="impl"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#119-542">source</a><a
href="#impl-Field" class="anchor">§</a><h3 class="code-header">impl <a
class="struct" href="struct.Field.html" title="struct arrow_schema::field::Fi
[...]
</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_dict" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#133-148">source</a><h4
class="code-header">pub fn <a href="#method.new_dict" class="fn">new_dict</a>(
name: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a>>,
data_type: <a class="enum" href="../datatype/enum.DataType.html"
title="enum arrow_schema::datatype::DataType">DataType</a>,
@@ -32,11 +32,11 @@
nullable: <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a>
) -> Self</h4></section></summary><div class="docblock"><p>Create a new <a
href="struct.Field.html" title="struct
arrow_schema::field::Field"><code>Field</code></a> with <a
href="../datatype/enum.DataType.html#variant.Struct" title="variant
arrow_schema::datatype::DataType::Struct"><code>DataType::Struct</code></a></p>
<ul>
-<li><code>name</code>: the name of the <a
href="../datatype/enum.DataType.html#variant.List" title="variant
arrow_schema::datatype::DataType::List"><code>DataType::List</code></a>
field</li>
+<li><code>name</code>: the name of the <a
href="../datatype/enum.DataType.html#variant.Struct" title="variant
arrow_schema::datatype::DataType::Struct"><code>DataType::Struct</code></a>
field</li>
<li><code>fields</code>: the description of each struct element</li>
<li><code>nullable</code>: if the <a
href="../datatype/enum.DataType.html#variant.Struct" title="variant
arrow_schema::datatype::DataType::Struct"><code>DataType::Struct</code></a>
array is nullable</li>
</ul>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_list" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#191-197">source</a><h4
class="code-header">pub fn <a href="#method.new_list" class="fn">new_list</a>(
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_list" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#189-195">source</a><h4
class="code-header">pub fn <a href="#method.new_list" class="fn">new_list</a>(
name: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a>>,
value: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="type"
href="type.FieldRef.html" title="type
arrow_schema::field::FieldRef">FieldRef</a>>,
nullable: <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a>
@@ -46,8 +46,7 @@
<li><code>value</code>: the description of each list element</li>
<li><code>nullable</code>: if the <a
href="../datatype/enum.DataType.html#variant.List" title="variant
arrow_schema::datatype::DataType::List"><code>DataType::List</code></a> array
is nullable</li>
</ul>
-<p>Uses “item” as the name of the child field, this can be overridden with <a
href="struct.Field.html#method.new" title="associated function
arrow_schema::field::Field::new"><code>Self::new</code></a></p>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_large_list" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#204-210">source</a><h4
class="code-header">pub fn <a href="#method.new_large_list"
class="fn">new_large_list</a>(
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_large_list" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#202-208">source</a><h4
class="code-header">pub fn <a href="#method.new_large_list"
class="fn">new_large_list</a>(
name: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a>>,
value: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="type"
href="type.FieldRef.html" title="type
arrow_schema::field::FieldRef">FieldRef</a>>,
nullable: <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a>
@@ -57,7 +56,7 @@
<li><code>value</code>: the description of each list element</li>
<li><code>nullable</code>: if the <a
href="../datatype/enum.DataType.html#variant.LargeList" title="variant
arrow_schema::datatype::DataType::LargeList"><code>DataType::LargeList</code></a>
array is nullable</li>
</ul>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_map" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#220-237">source</a><h4
class="code-header">pub fn <a href="#method.new_map" class="fn">new_map</a>(
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_map" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#218-235">source</a><h4
class="code-header">pub fn <a href="#method.new_map" class="fn">new_map</a>(
name: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a>>,
entries: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a>>,
keys: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="type"
href="type.FieldRef.html" title="type
arrow_schema::field::FieldRef">FieldRef</a>>,
@@ -73,7 +72,7 @@
<li><code>sorted</code>: if the <a
href="../datatype/enum.DataType.html#variant.Map" title="variant
arrow_schema::datatype::DataType::Map"><code>DataType::Map</code></a> array is
sorted</li>
<li><code>nullable</code>: if the <a
href="../datatype/enum.DataType.html#variant.Map" title="variant
arrow_schema::datatype::DataType::Map"><code>DataType::Map</code></a> array is
nullable</li>
</ul>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_union" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#245-257">source</a><h4
class="code-header">pub fn <a href="#method.new_union"
class="fn">new_union</a><S, F, T>(
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_union" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#243-255">source</a><h4
class="code-header">pub fn <a href="#method.new_union"
class="fn">new_union</a><S, F, T>(
name: S,
type_ids: T,
fields: F,
@@ -89,37 +88,37 @@
<li><code>fields</code>: the union fields</li>
<li><code>mode</code>: the union mode</li>
</ul>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.set_metadata" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#261-263">source</a><h4
class="code-header">pub fn <a href="#method.set_metadata"
class="fn">set_metadata</a>(&mut self, metadata: <a class="struct"
href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html";
title="struct std::collections::hash::map::HashMap">HashMap</a><<a [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_metadata" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#266-269">source</a><h4
class="code-header">pub fn <a href="#method.with_metadata"
class="fn">with_metadata</a>(self, metadata: <a class="struct"
href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html";
title="struct std::collections::hash::map::HashMap">HashMap</a><<a class
[...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.metadata" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#273-275">source</a><h4
class="code-header">pub const fn <a href="#method.metadata"
class="fn">metadata</a>(&self) -> &<a class="struct"
href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html";
title="struct std::collections::hash::map::HashMap">HashMap</a><<a class="s
[...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.name" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#279-281">source</a><h4
class="code-header">pub const fn <a href="#method.name"
class="fn">name</a>(&self) -> &<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a></h4></section></summary><div
class="docblock"><p>Return [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_name" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#292-295">source</a><h4
class="code-header">pub fn <a href="#method.with_name"
class="fn">with_name</a>(self, name: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.set_metadata" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#259-261">source</a><h4
class="code-header">pub fn <a href="#method.set_metadata"
class="fn">set_metadata</a>(&mut self, metadata: <a class="struct"
href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html";
title="struct std::collections::hash::map::HashMap">HashMap</a><<a [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_metadata" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#264-267">source</a><h4
class="code-header">pub fn <a href="#method.with_metadata"
class="fn">with_metadata</a>(self, metadata: <a class="struct"
href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html";
title="struct std::collections::hash::map::HashMap">HashMap</a><<a class
[...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.metadata" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#271-273">source</a><h4
class="code-header">pub const fn <a href="#method.metadata"
class="fn">metadata</a>(&self) -> &<a class="struct"
href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html";
title="struct std::collections::hash::map::HashMap">HashMap</a><<a class="s
[...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.name" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#277-279">source</a><h4
class="code-header">pub const fn <a href="#method.name"
class="fn">name</a>(&self) -> &<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a></h4></section></summary><div
class="docblock"><p>Return [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_name" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#290-293">source</a><h4
class="code-header">pub fn <a href="#method.with_name"
class="fn">with_name</a>(self, name: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly [...]
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span
class="kw">let </span>field = Field::new(<span
class="string">"c1"</span>, DataType::Int64, <span
class="bool-val">false</span>)
.with_name(<span class="string">"c2"</span>);
<span class="macro">assert_eq!</span>(field.name(), <span
class="string">"c2"</span>);</code></pre></div>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.data_type" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#299-301">source</a><h4
class="code-header">pub const fn <a href="#method.data_type"
class="fn">data_type</a>(&self) -> &<a class="enum"
href="../datatype/enum.DataType.html" title="enum
arrow_schema::datatype::DataType">DataType</a></h4></section></summary><div
class="docblock"><p>Returns an immuta [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_data_type" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#312-315">source</a><h4
class="code-header">pub fn <a href="#method.with_data_type"
class="fn">with_data_type</a>(self, data_type: <a class="enum"
href="../datatype/enum.DataType.html" title="enum
arrow_schema::datatype::DataType">DataType</a>) ->
Self</h4></section></summary><div class="docblock"><p>S [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.data_type" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#297-299">source</a><h4
class="code-header">pub const fn <a href="#method.data_type"
class="fn">data_type</a>(&self) -> &<a class="enum"
href="../datatype/enum.DataType.html" title="enum
arrow_schema::datatype::DataType">DataType</a></h4></section></summary><div
class="docblock"><p>Returns an immuta [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_data_type" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#310-313">source</a><h4
class="code-header">pub fn <a href="#method.with_data_type"
class="fn">with_data_type</a>(self, data_type: <a class="enum"
href="../datatype/enum.DataType.html" title="enum
arrow_schema::datatype::DataType">DataType</a>) ->
Self</h4></section></summary><div class="docblock"><p>S [...]
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span
class="kw">let </span>field = Field::new(<span
class="string">"c1"</span>, DataType::Int64, <span
class="bool-val">false</span>)
.with_data_type(DataType::Utf8);
<span class="macro">assert_eq!</span>(field.data_type(), <span
class="kw-2">&</span>DataType::Utf8);</code></pre></div>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.is_nullable" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#319-321">source</a><h4
class="code-header">pub const fn <a href="#method.is_nullable"
class="fn">is_nullable</a>(&self) -> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a></h4></section></summary><div
class="docblock"><p>Indicates whether this <a href="st [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_nullable" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#332-335">source</a><h4
class="code-header">pub fn <a href="#method.with_nullable"
class="fn">with_nullable</a>(self, nullable: <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a>)
-> Self</h4></section></summary><div class="docblock"><p>Set
<code>nullable</cod [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.is_nullable" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#317-319">source</a><h4
class="code-header">pub const fn <a href="#method.is_nullable"
class="fn">is_nullable</a>(&self) -> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a></h4></section></summary><div
class="docblock"><p>Indicates whether this <a href="st [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_nullable" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#330-333">source</a><h4
class="code-header">pub fn <a href="#method.with_nullable"
class="fn">with_nullable</a>(self, nullable: <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a>)
-> Self</h4></section></summary><div class="docblock"><p>Set
<code>nullable</cod [...]
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span
class="kw">let </span>field = Field::new(<span
class="string">"c1"</span>, DataType::Int64, <span
class="bool-val">false</span>)
.with_nullable(<span class="bool-val">true</span>);
<span class="macro">assert_eq!</span>(field.is_nullable(), <span
class="bool-val">true</span>);</code></pre></div>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.fields" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#339-344">source</a><h4
class="code-header">pub(crate) fn <a href="#method.fields"
class="fn">fields</a>(&self) -> <a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html";
title="struct alloc::vec::Vec">Vec</a><&<a class="struct"
href="struct.Field.html" title="struct arr [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.fields" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#337-342">source</a><h4
class="code-header">pub(crate) fn <a href="#method.fields"
class="fn">fields</a>(&self) -> <a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html";
title="struct alloc::vec::Vec">Vec</a><&<a class="struct"
href="struct.Field.html" title="struct arr [...]
within <code>self</code> contained within this field (including
<code>self</code>)</p>
-</div></details><section id="method._fields" class="method"><a class="src
rightside" href="../../src/arrow_schema/field.rs.html#346-359">source</a><h4
class="code-header">fn <a href="#method._fields" class="fn">_fields</a>(dt:
&<a class="enum" href="../datatype/enum.DataType.html" title="enum
arrow_schema::datatype::DataType">DataType</a>) -> <a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html";
title="struct alloc::vec::Vec">Vec</a><&<a class [...]
+</div></details><section id="method._fields" class="method"><a class="src
rightside" href="../../src/arrow_schema/field.rs.html#344-357">source</a><h4
class="code-header">fn <a href="#method._fields" class="fn">_fields</a>(dt:
&<a class="enum" href="../datatype/enum.DataType.html" title="enum
arrow_schema::datatype::DataType">DataType</a>) -> <a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html";
title="struct alloc::vec::Vec">Vec</a><&<a class [...]
dictionary ID they use</p>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.dict_id" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#376-381">source</a><h4
class="code-header">pub const fn <a href="#method.dict_id"
class="fn">dict_id</a>(&self) -> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html";
title="enum core::option::Option">Option</a><<a class="primitive"
href="https://doc.rust-lang.org/nig [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.dict_is_ordered" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#385-390">source</a><h4
class="code-header">pub const fn <a href="#method.dict_is_ordered"
class="fn">dict_is_ordered</a>(&self) -> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html";
title="enum core::option::Option">Option</a><<a class="primitive"
href="https [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.try_merge" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#406-510">source</a><h4
class="code-header">pub fn <a href="#method.try_merge"
class="fn">try_merge</a>(&mut self, from: &<a class="struct"
href="struct.Field.html" title="struct arrow_schema::field::Field">Field</a>)
-> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/result/enum.Result [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.dict_id" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#374-379">source</a><h4
class="code-header">pub const fn <a href="#method.dict_id"
class="fn">dict_id</a>(&self) -> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html";
title="enum core::option::Option">Option</a><<a class="primitive"
href="https://doc.rust-lang.org/nig [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.dict_is_ordered" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#383-388">source</a><h4
class="code-header">pub const fn <a href="#method.dict_is_ordered"
class="fn">dict_is_ordered</a>(&self) -> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html";
title="enum core::option::Option">Option</a><<a class="primitive"
href="https [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.try_merge" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#404-508">source</a><h4
class="code-header">pub fn <a href="#method.try_merge"
class="fn">try_merge</a>(&mut self, from: &<a class="struct"
href="struct.Field.html" title="struct arrow_schema::field::Field">Field</a>)
-> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/result/enum.Result [...]
<p>Struct fields are merged recursively.</p>
<p>NOTE: <code>self</code> may be updated to a partial / unexpected state in
case of merge failure.</p>
<p>Example:</p>
@@ -127,16 +126,16 @@ dictionary ID they use</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span
class="kw">let </span><span class="kw-2">mut </span>field = Field::new(<span
class="string">"c1"</span>, DataType::Int64, <span
class="bool-val">false</span>);
<span class="macro">assert!</span>(field.try_merge(<span
class="kw-2">&</span>Field::new(<span class="string">"c1"</span>,
DataType::Int64, <span class="bool-val">true</span>)).is_ok());
<span class="macro">assert!</span>(field.is_nullable());</code></pre></div>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.contains" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#517-528">source</a><h4
class="code-header">pub fn <a href="#method.contains"
class="fn">contains</a>(&self, other: &<a class="struct"
href="struct.Field.html" title="struct arrow_schema::field::Field">Field</a>)
-> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html"; [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.contains" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#515-526">source</a><h4
class="code-header">pub fn <a href="#method.contains"
class="fn">contains</a>(&self, other: &<a class="struct"
href="struct.Field.html" title="struct arrow_schema::field::Field">Field</a>)
-> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html"; [...]
<ul>
<li>if nullability doesn’t match, self needs to be nullable</li>
<li>self.metadata is a superset of other.metadata</li>
<li>all other fields are equal</li>
</ul>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.size" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#533-543">source</a><h4
class="code-header">pub fn <a href="#method.size"
class="fn">size</a>(&self) -> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.usize.html";>usize</a></h4></section></summary><div
class="docblock"><p>Return size of this instance in bytes.</p>
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.size" class="method"><a class="src rightside"
href="../../src/arrow_schema/field.rs.html#531-541">source</a><h4
class="code-header">pub fn <a href="#method.size"
class="fn">size</a>(&self) -> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.usize.html";>usize</a></h4></section></summary><div
class="docblock"><p>Return size of this instance in bytes.</p>
<p>Includes the size of <code>Self</code>.</p>
</div></details></div></details></div><h2 id="trait-implementations"
class="small-section-header">Trait Implementations<a
href="#trait-implementations" class="anchor">§</a></h2><div
id="trait-implementations-list"><details class="toggle implementors-toggle"
open><summary><section id="impl-Clone-for-Field" class="impl"><a class="src
rightside" href="../../src/arrow_schema/field.rs.html#35">source</a><a
href="#impl-Clone-for-Field" class="anchor">§</a><h3 class="code-header">impl
<a class= [...]
- __D: <a class="trait"
href="https://docs.rs/serde/1.0.174/serde/de/trait.Deserializer.html";
title="trait
serde::de::Deserializer">Deserializer</a><'de>,</span></h4></section></summary><div
class='docblock'>Deserialize this value from the given Serde deserializer. <a
href="https://docs.rs/serde/1.0.174/serde/de/trait.Deserialize.html#tymethod.deserialize";>Read
more</a></div></details></div></details><details class="toggle
implementors-toggle" open><summary><section id="impl-Disp [...]
+ __D: <a class="trait"
href="https://docs.rs/serde/1.0.174/serde/de/trait.Deserializer.html";
title="trait
serde::de::Deserializer">Deserializer</a><'de>,</span></h4></section></summary><div
class='docblock'>Deserialize this value from the given Serde deserializer. <a
href="https://docs.rs/serde/1.0.174/serde/de/trait.Deserialize.html#tymethod.deserialize";>Read
more</a></div></details></div></details><details class="toggle
implementors-toggle" open><summary><section id="impl-Disp [...]
H: <a class="trait"
href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html";
title="trait core::hash::Hasher">Hasher</a>,
Self: <a class="trait"
href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html";
title="trait
core::marker::Sized">Sized</a>,</span></h4></section></summary><div
class='docblock'>Feeds a slice of this type into the given <a
href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html";
title="trait core::hash::Hasher"><code>Hasher</code></a>. <a
href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice";>Read
more</a></div></details></div></ [...]
Self: <a class="trait"
href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html";
title="trait
core::marker::Sized">Sized</a>,</span></h4></section></summary><div
class='docblock'>Compares and returns the maximum of two values. <a
href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.max";>Read
more</a></div></details><details class="toggle method-toggle"
open><summary><section id="method.min" class="method trait-impl"><span
class="rightside"><span class="s [...]
diff --git a/arrow_schema/struct.Field.html b/arrow_schema/struct.Field.html
index 767bc3e795..60876d771e 100644
--- a/arrow_schema/struct.Field.html
+++ b/arrow_schema/struct.Field.html
@@ -9,7 +9,7 @@
<p>A <a href="schema/struct.Schema.html" title="struct
arrow_schema::schema::Schema"><code>Schema</code></a> is an ordered collection
of
<a href="field/struct.Field.html" title="struct
arrow_schema::field::Field"><code>Field</code></a> objects.</p>
</div></details><h2 id="fields" class="fields small-section-header">Fields<a
href="#fields" class="anchor">§</a></h2><span id="structfield.name"
class="structfield small-section-header"><a href="#structfield.name"
class="anchor field">§</a><code>name: <a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a></code></span><span
id="structfield.data_type" class="structfield small-section-header"><a
href="#stru [...]
-</div><h2 id="implementations" class="small-section-header">Implementations<a
href="#implementations" class="anchor">§</a></h2><div
id="implementations-list"><details class="toggle implementors-toggle"
open><summary><section id="impl-Field" class="impl"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#119-544">source</a><a
href="#impl-Field" class="anchor">§</a><h3 class="code-header">impl <a
class="struct" href="field/struct.Field.html" title="struct
arrow_schema::field: [...]
+</div><h2 id="implementations" class="small-section-header">Implementations<a
href="#implementations" class="anchor">§</a></h2><div
id="implementations-list"><details class="toggle implementors-toggle"
open><summary><section id="impl-Field" class="impl"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#119-542">source</a><a
href="#impl-Field" class="anchor">§</a><h3 class="code-header">impl <a
class="struct" href="field/struct.Field.html" title="struct
arrow_schema::field: [...]
</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_dict" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#133-148">source</a><h4
class="code-header">pub fn <a href="#method.new_dict" class="fn">new_dict</a>(
name: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a>>,
data_type: <a class="enum" href="datatype/enum.DataType.html" title="enum
arrow_schema::datatype::DataType">DataType</a>,
@@ -32,11 +32,11 @@
nullable: <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a>
) -> Self</h4></section></summary><div class="docblock"><p>Create a new <a
href="field/struct.Field.html" title="struct
arrow_schema::field::Field"><code>Field</code></a> with <a
href="datatype/enum.DataType.html#variant.Struct" title="variant
arrow_schema::datatype::DataType::Struct"><code>DataType::Struct</code></a></p>
<ul>
-<li><code>name</code>: the name of the <a
href="datatype/enum.DataType.html#variant.List" title="variant
arrow_schema::datatype::DataType::List"><code>DataType::List</code></a>
field</li>
+<li><code>name</code>: the name of the <a
href="datatype/enum.DataType.html#variant.Struct" title="variant
arrow_schema::datatype::DataType::Struct"><code>DataType::Struct</code></a>
field</li>
<li><code>fields</code>: the description of each struct element</li>
<li><code>nullable</code>: if the <a
href="datatype/enum.DataType.html#variant.Struct" title="variant
arrow_schema::datatype::DataType::Struct"><code>DataType::Struct</code></a>
array is nullable</li>
</ul>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_list" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#191-197">source</a><h4
class="code-header">pub fn <a href="#method.new_list" class="fn">new_list</a>(
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_list" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#189-195">source</a><h4
class="code-header">pub fn <a href="#method.new_list" class="fn">new_list</a>(
name: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a>>,
value: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="type"
href="field/type.FieldRef.html" title="type
arrow_schema::field::FieldRef">FieldRef</a>>,
nullable: <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a>
@@ -46,8 +46,7 @@
<li><code>value</code>: the description of each list element</li>
<li><code>nullable</code>: if the <a
href="datatype/enum.DataType.html#variant.List" title="variant
arrow_schema::datatype::DataType::List"><code>DataType::List</code></a> array
is nullable</li>
</ul>
-<p>Uses “item” as the name of the child field, this can be overridden with <a
href="field/struct.Field.html#method.new" title="associated function
arrow_schema::field::Field::new"><code>Self::new</code></a></p>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_large_list" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#204-210">source</a><h4
class="code-header">pub fn <a href="#method.new_large_list"
class="fn">new_large_list</a>(
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_large_list" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#202-208">source</a><h4
class="code-header">pub fn <a href="#method.new_large_list"
class="fn">new_large_list</a>(
name: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a>>,
value: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="type"
href="field/type.FieldRef.html" title="type
arrow_schema::field::FieldRef">FieldRef</a>>,
nullable: <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a>
@@ -57,7 +56,7 @@
<li><code>value</code>: the description of each list element</li>
<li><code>nullable</code>: if the <a
href="datatype/enum.DataType.html#variant.LargeList" title="variant
arrow_schema::datatype::DataType::LargeList"><code>DataType::LargeList</code></a>
array is nullable</li>
</ul>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_map" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#220-237">source</a><h4
class="code-header">pub fn <a href="#method.new_map" class="fn">new_map</a>(
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_map" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#218-235">source</a><h4
class="code-header">pub fn <a href="#method.new_map" class="fn">new_map</a>(
name: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a>>,
entries: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a>>,
keys: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="type"
href="field/type.FieldRef.html" title="type
arrow_schema::field::FieldRef">FieldRef</a>>,
@@ -73,7 +72,7 @@
<li><code>sorted</code>: if the <a
href="datatype/enum.DataType.html#variant.Map" title="variant
arrow_schema::datatype::DataType::Map"><code>DataType::Map</code></a> array is
sorted</li>
<li><code>nullable</code>: if the <a
href="datatype/enum.DataType.html#variant.Map" title="variant
arrow_schema::datatype::DataType::Map"><code>DataType::Map</code></a> array is
nullable</li>
</ul>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_union" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#245-257">source</a><h4
class="code-header">pub fn <a href="#method.new_union"
class="fn">new_union</a><S, F, T>(
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.new_union" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#243-255">source</a><h4
class="code-header">pub fn <a href="#method.new_union"
class="fn">new_union</a><S, F, T>(
name: S,
type_ids: T,
fields: F,
@@ -89,37 +88,37 @@
<li><code>fields</code>: the union fields</li>
<li><code>mode</code>: the union mode</li>
</ul>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.set_metadata" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#261-263">source</a><h4
class="code-header">pub fn <a href="#method.set_metadata"
class="fn">set_metadata</a>(&mut self, metadata: <a class="struct"
href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html";
title="struct std::collections::hash::map::HashMap">HashMap</a><<a cl [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_metadata" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#266-269">source</a><h4
class="code-header">pub fn <a href="#method.with_metadata"
class="fn">with_metadata</a>(self, metadata: <a class="struct"
href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html";
title="struct std::collections::hash::map::HashMap">HashMap</a><<a class="s
[...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.metadata" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#273-275">source</a><h4
class="code-header">pub const fn <a href="#method.metadata"
class="fn">metadata</a>(&self) -> &<a class="struct"
href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html";
title="struct std::collections::hash::map::HashMap">HashMap</a><<a
class="stru [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.name" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#279-281">source</a><h4
class="code-header">pub const fn <a href="#method.name"
class="fn">name</a>(&self) -> &<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a></h4></section></summary><div
class="docblock"><p>Returns a [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_name" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#292-295">source</a><h4
class="code-header">pub fn <a href="#method.with_name"
class="fn">with_name</a>(self, name: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/al [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.set_metadata" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#259-261">source</a><h4
class="code-header">pub fn <a href="#method.set_metadata"
class="fn">set_metadata</a>(&mut self, metadata: <a class="struct"
href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html";
title="struct std::collections::hash::map::HashMap">HashMap</a><<a cl [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_metadata" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#264-267">source</a><h4
class="code-header">pub fn <a href="#method.with_metadata"
class="fn">with_metadata</a>(self, metadata: <a class="struct"
href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html";
title="struct std::collections::hash::map::HashMap">HashMap</a><<a class="s
[...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.metadata" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#271-273">source</a><h4
class="code-header">pub const fn <a href="#method.metadata"
class="fn">metadata</a>(&self) -> &<a class="struct"
href="https://doc.rust-lang.org/nightly/std/collections/hash/map/struct.HashMap.html";
title="struct std::collections::hash::map::HashMap">HashMap</a><<a
class="stru [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.name" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#277-279">source</a><h4
class="code-header">pub const fn <a href="#method.name"
class="fn">name</a>(&self) -> &<a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html";
title="struct alloc::string::String">String</a></h4></section></summary><div
class="docblock"><p>Returns a [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_name" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#290-293">source</a><h4
class="code-header">pub fn <a href="#method.with_name"
class="fn">with_name</a>(self, name: impl <a class="trait"
href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html";
title="trait core::convert::Into">Into</a><<a class="struct"
href="https://doc.rust-lang.org/nightly/al [...]
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span
class="kw">let </span>field = Field::new(<span
class="string">"c1"</span>, DataType::Int64, <span
class="bool-val">false</span>)
.with_name(<span class="string">"c2"</span>);
<span class="macro">assert_eq!</span>(field.name(), <span
class="string">"c2"</span>);</code></pre></div>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.data_type" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#299-301">source</a><h4
class="code-header">pub const fn <a href="#method.data_type"
class="fn">data_type</a>(&self) -> &<a class="enum"
href="datatype/enum.DataType.html" title="enum
arrow_schema::datatype::DataType">DataType</a></h4></section></summary><div
class="docblock"><p>Returns an immutable re [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_data_type" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#312-315">source</a><h4
class="code-header">pub fn <a href="#method.with_data_type"
class="fn">with_data_type</a>(self, data_type: <a class="enum"
href="datatype/enum.DataType.html" title="enum
arrow_schema::datatype::DataType">DataType</a>) ->
Self</h4></section></summary><div class="docblock"><p>Set <a [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.data_type" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#297-299">source</a><h4
class="code-header">pub const fn <a href="#method.data_type"
class="fn">data_type</a>(&self) -> &<a class="enum"
href="datatype/enum.DataType.html" title="enum
arrow_schema::datatype::DataType">DataType</a></h4></section></summary><div
class="docblock"><p>Returns an immutable re [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_data_type" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#310-313">source</a><h4
class="code-header">pub fn <a href="#method.with_data_type"
class="fn">with_data_type</a>(self, data_type: <a class="enum"
href="datatype/enum.DataType.html" title="enum
arrow_schema::datatype::DataType">DataType</a>) ->
Self</h4></section></summary><div class="docblock"><p>Set <a [...]
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span
class="kw">let </span>field = Field::new(<span
class="string">"c1"</span>, DataType::Int64, <span
class="bool-val">false</span>)
.with_data_type(DataType::Utf8);
<span class="macro">assert_eq!</span>(field.data_type(), <span
class="kw-2">&</span>DataType::Utf8);</code></pre></div>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.is_nullable" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#319-321">source</a><h4
class="code-header">pub const fn <a href="#method.is_nullable"
class="fn">is_nullable</a>(&self) -> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a></h4></section></summary><div
class="docblock"><p>Indicates whether this <a href="field [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_nullable" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#332-335">source</a><h4
class="code-header">pub fn <a href="#method.with_nullable"
class="fn">with_nullable</a>(self, nullable: <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a>)
-> Self</h4></section></summary><div class="docblock"><p>Set
<code>nullable</code> [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.is_nullable" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#317-319">source</a><h4
class="code-header">pub const fn <a href="#method.is_nullable"
class="fn">is_nullable</a>(&self) -> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a></h4></section></summary><div
class="docblock"><p>Indicates whether this <a href="field [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.with_nullable" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#330-333">source</a><h4
class="code-header">pub fn <a href="#method.with_nullable"
class="fn">with_nullable</a>(self, nullable: <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.html";>bool</a>)
-> Self</h4></section></summary><div class="docblock"><p>Set
<code>nullable</code> [...]
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span
class="kw">let </span>field = Field::new(<span
class="string">"c1"</span>, DataType::Int64, <span
class="bool-val">false</span>)
.with_nullable(<span class="bool-val">true</span>);
<span class="macro">assert_eq!</span>(field.is_nullable(), <span
class="bool-val">true</span>);</code></pre></div>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.fields" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#339-344">source</a><h4
class="code-header">pub(crate) fn <a href="#method.fields"
class="fn">fields</a>(&self) -> <a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html";
title="struct alloc::vec::Vec">Vec</a><&<a class="struct"
href="field/struct.Field.html" title="struct [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.fields" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#337-342">source</a><h4
class="code-header">pub(crate) fn <a href="#method.fields"
class="fn">fields</a>(&self) -> <a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html";
title="struct alloc::vec::Vec">Vec</a><&<a class="struct"
href="field/struct.Field.html" title="struct [...]
within <code>self</code> contained within this field (including
<code>self</code>)</p>
-</div></details><section id="method._fields" class="method"><a class="src
rightside" href="../src/arrow_schema/field.rs.html#346-359">source</a><h4
class="code-header">fn <a href="#method._fields" class="fn">_fields</a>(dt:
&<a class="enum" href="datatype/enum.DataType.html" title="enum
arrow_schema::datatype::DataType">DataType</a>) -> <a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html";
title="struct alloc::vec::Vec">Vec</a><&<a class="stru [...]
+</div></details><section id="method._fields" class="method"><a class="src
rightside" href="../src/arrow_schema/field.rs.html#344-357">source</a><h4
class="code-header">fn <a href="#method._fields" class="fn">_fields</a>(dt:
&<a class="enum" href="datatype/enum.DataType.html" title="enum
arrow_schema::datatype::DataType">DataType</a>) -> <a class="struct"
href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html";
title="struct alloc::vec::Vec">Vec</a><&<a class="stru [...]
dictionary ID they use</p>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.dict_id" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#376-381">source</a><h4
class="code-header">pub const fn <a href="#method.dict_id"
class="fn">dict_id</a>(&self) -> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html";
title="enum core::option::Option">Option</a><<a class="primitive"
href="https://doc.rust-lang.org/nightl [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.dict_is_ordered" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#385-390">source</a><h4
class="code-header">pub const fn <a href="#method.dict_is_ordered"
class="fn">dict_is_ordered</a>(&self) -> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html";
title="enum core::option::Option">Option</a><<a class="primitive"
href="https:// [...]
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.try_merge" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#406-510">source</a><h4
class="code-header">pub fn <a href="#method.try_merge"
class="fn">try_merge</a>(&mut self, from: &<a class="struct"
href="field/struct.Field.html" title="struct
arrow_schema::field::Field">Field</a>) -> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/result/enum.Res [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.dict_id" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#374-379">source</a><h4
class="code-header">pub const fn <a href="#method.dict_id"
class="fn">dict_id</a>(&self) -> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html";
title="enum core::option::Option">Option</a><<a class="primitive"
href="https://doc.rust-lang.org/nightl [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.dict_is_ordered" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#383-388">source</a><h4
class="code-header">pub const fn <a href="#method.dict_is_ordered"
class="fn">dict_is_ordered</a>(&self) -> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html";
title="enum core::option::Option">Option</a><<a class="primitive"
href="https:// [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.try_merge" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#404-508">source</a><h4
class="code-header">pub fn <a href="#method.try_merge"
class="fn">try_merge</a>(&mut self, from: &<a class="struct"
href="field/struct.Field.html" title="struct
arrow_schema::field::Field">Field</a>) -> <a class="enum"
href="https://doc.rust-lang.org/nightly/core/result/enum.Res [...]
<p>Struct fields are merged recursively.</p>
<p>NOTE: <code>self</code> may be updated to a partial / unexpected state in
case of merge failure.</p>
<p>Example:</p>
@@ -127,16 +126,16 @@ dictionary ID they use</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span
class="kw">let </span><span class="kw-2">mut </span>field = Field::new(<span
class="string">"c1"</span>, DataType::Int64, <span
class="bool-val">false</span>);
<span class="macro">assert!</span>(field.try_merge(<span
class="kw-2">&</span>Field::new(<span class="string">"c1"</span>,
DataType::Int64, <span class="bool-val">true</span>)).is_ok());
<span class="macro">assert!</span>(field.is_nullable());</code></pre></div>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.contains" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#517-528">source</a><h4
class="code-header">pub fn <a href="#method.contains"
class="fn">contains</a>(&self, other: &<a class="struct"
href="field/struct.Field.html" title="struct
arrow_schema::field::Field">Field</a>) -> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.ht [...]
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.contains" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#515-526">source</a><h4
class="code-header">pub fn <a href="#method.contains"
class="fn">contains</a>(&self, other: &<a class="struct"
href="field/struct.Field.html" title="struct
arrow_schema::field::Field">Field</a>) -> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.bool.ht [...]
<ul>
<li>if nullability doesn’t match, self needs to be nullable</li>
<li>self.metadata is a superset of other.metadata</li>
<li>all other fields are equal</li>
</ul>
-</div></details><details class="toggle method-toggle" open><summary><section
id="method.size" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#533-543">source</a><h4
class="code-header">pub fn <a href="#method.size"
class="fn">size</a>(&self) -> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.usize.html";>usize</a></h4></section></summary><div
class="docblock"><p>Return size of this instance in bytes.</p>
+</div></details><details class="toggle method-toggle" open><summary><section
id="method.size" class="method"><a class="src rightside"
href="../src/arrow_schema/field.rs.html#531-541">source</a><h4
class="code-header">pub fn <a href="#method.size"
class="fn">size</a>(&self) -> <a class="primitive"
href="https://doc.rust-lang.org/nightly/std/primitive.usize.html";>usize</a></h4></section></summary><div
class="docblock"><p>Return size of this instance in bytes.</p>
<p>Includes the size of <code>Self</code>.</p>
</div></details></div></details></div><h2 id="trait-implementations"
class="small-section-header">Trait Implementations<a
href="#trait-implementations" class="anchor">§</a></h2><div
id="trait-implementations-list"><details class="toggle implementors-toggle"
open><summary><section id="impl-Clone-for-Field" class="impl"><a class="src
rightside" href="../src/arrow_schema/field.rs.html#35">source</a><a
href="#impl-Clone-for-Field" class="anchor">§</a><h3 class="code-header">impl
<a class="tr [...]
- __D: <a class="trait"
href="https://docs.rs/serde/1.0.174/serde/de/trait.Deserializer.html";
title="trait
serde::de::Deserializer">Deserializer</a><'de>,</span></h4></section></summary><div
class='docblock'>Deserialize this value from the given Serde deserializer. <a
href="https://docs.rs/serde/1.0.174/serde/de/trait.Deserialize.html#tymethod.deserialize";>Read
more</a></div></details></div></details><details class="toggle
implementors-toggle" open><summary><section id="impl-Disp [...]
+ __D: <a class="trait"
href="https://docs.rs/serde/1.0.174/serde/de/trait.Deserializer.html";
title="trait
serde::de::Deserializer">Deserializer</a><'de>,</span></h4></section></summary><div
class='docblock'>Deserialize this value from the given Serde deserializer. <a
href="https://docs.rs/serde/1.0.174/serde/de/trait.Deserialize.html#tymethod.deserialize";>Read
more</a></div></details></div></details><details class="toggle
implementors-toggle" open><summary><section id="impl-Disp [...]
H: <a class="trait"
href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html";
title="trait core::hash::Hasher">Hasher</a>,
Self: <a class="trait"
href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html";
title="trait
core::marker::Sized">Sized</a>,</span></h4></section></summary><div
class='docblock'>Feeds a slice of this type into the given <a
href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html";
title="trait core::hash::Hasher"><code>Hasher</code></a>. <a
href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice";>Read
more</a></div></details></div></ [...]
Self: <a class="trait"
href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html";
title="trait
core::marker::Sized">Sized</a>,</span></h4></section></summary><div
class='docblock'>Compares and returns the maximum of two values. <a
href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.max";>Read
more</a></div></details><details class="toggle method-toggle"
open><summary><section id="method.min" class="method trait-impl"><span
class="rightside"><span class="s [...]
diff --git a/src/arrow_schema/field.rs.html b/src/arrow_schema/field.rs.html
index 341a4bb3c7..8ae0ea44ea 100644
--- a/src/arrow_schema/field.rs.html
+++ b/src/arrow_schema/field.rs.html
@@ -853,8 +853,6 @@
<a href="#853" id="853">853</a>
<a href="#854" id="854">854</a>
<a href="#855" id="855">855</a>
-<a href="#856" id="856">856</a>
-<a href="#857" id="857">857</a>
</pre></div><pre class="rust"><code><span class="comment">// Licensed to the
Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
@@ -1027,7 +1025,7 @@
<span class="doccomment">/// Create a new [`Field`] with
[`DataType::Struct`]
///
- /// - `name`: the name of the [`DataType::List`] field
+ /// - `name`: the name of the [`DataType::Struct`] field
/// - `fields`: the description of each struct element
/// - `nullable`: if the [`DataType::Struct`] array is nullable
</span><span class="kw">pub fn </span>new_struct(
@@ -1043,8 +1041,6 @@
/// - `name`: the name of the [`DataType::List`] field
/// - `value`: the description of each list element
/// - `nullable`: if the [`DataType::List`] array is nullable
- ///
- /// Uses "item" as the name of the child field, this can be
overridden with [`Self::new`]
</span><span class="kw">pub fn </span>new_list(
name: <span class="kw">impl </span>Into<String>,
value: <span class="kw">impl </span>Into<FieldRef>,
