| <!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="A `DictionaryArray` with the key type erased"><title>AnyDictionaryArray in arrow_array::array - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="arrow_array" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (6501e64fc 2025-10-23)" data-channel="nightly" data-search-js="search-d69d8955.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="icon" href="https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_transparent-bg.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">AnyDictionaryArray</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../arrow_array/index.html"><img src="https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg" alt="logo"></a><h2><a href="../../arrow_array/index.html">arrow_<wbr>array</a><span class="version">57.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">AnyDictionary<wbr>Array</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.keys" title="keys">keys</a></li><li><a href="#tymethod.normalized_keys" title="normalized_keys">normalized_keys</a></li><li><a href="#tymethod.values" title="values">values</a></li><li><a href="#tymethod.with_values" title="with_values">with_values</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In arrow_<wbr>array::<wbr>array</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">arrow_array</a>::<wbr><a href="index.html">array</a></div><h1>Trait <span class="trait">AnyDictionary<wbr>Array</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/arrow_array/array/dictionary_array.rs.html#1006-1027">Source</a> </span></div><pre class="rust item-decl"><code>pub trait AnyDictionaryArray: <a class="trait" href="trait.Array.html" title="trait arrow_array::array::Array">Array</a> { |
| // Required methods |
| fn <a href="#tymethod.keys" class="fn">keys</a>(&self) -> &dyn <a class="trait" href="trait.Array.html" title="trait arrow_array::array::Array">Array</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.values" class="fn">values</a>(&self) -> &<a class="type" href="type.ArrayRef.html" title="type arrow_array::array::ArrayRef">ArrayRef</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.normalized_keys" class="fn">normalized_keys</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.with_values" class="fn">with_values</a>(&self, values: <a class="type" href="type.ArrayRef.html" title="type arrow_array::array::ArrayRef">ArrayRef</a>) -> <a class="type" href="type.ArrayRef.html" title="type arrow_array::array::ArrayRef">ArrayRef</a>; |
| }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A <a href="struct.DictionaryArray.html" title="struct arrow_array::array::DictionaryArray"><code>DictionaryArray</code></a> with the key type erased</p> |
| <p>This can be used to efficiently implement kernels for all possible dictionary |
| keys without needing to create specialized implementations for each key type</p> |
| <p>For example</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code> |
| <span class="kw">fn </span>to_string(a: <span class="kw-2">&</span><span class="kw">dyn </span>Array) -> <span class="prelude-ty">Result</span><ArrayRef, ArrowError> { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(d) = a.as_any_dictionary_opt() { |
| <span class="comment">// Recursively handle dictionary input |
| </span><span class="kw">let </span>r = to_string(d.values().as_ref())<span class="question-mark">?</span>; |
| <span class="kw">return </span><span class="prelude-val">Ok</span>(d.with_values(r)); |
| } |
| <span class="macro">downcast_primitive_array!</span> { |
| a => <span class="prelude-val">Ok</span>(Arc::new(a.iter().map(|x| x.map(|x| <span class="macro">format!</span>(<span class="string">"{x:?}"</span>))).collect::<StringArray>())), |
| d => <span class="prelude-val">Err</span>(ArrowError::InvalidArgumentError(<span class="macro">format!</span>(<span class="string">"{d:?} not supported"</span>))) |
| } |
| } |
| |
| <span class="kw">let </span>result = to_string(<span class="kw-2">&</span>Int32Array::from(<span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>])).unwrap(); |
| <span class="kw">let </span>actual = result.as_string::<i32>().iter().map(Option::unwrap).collect::<Vec<<span class="kw">_</span>>>(); |
| <span class="macro">assert_eq!</span>(actual, <span class="kw-2">&</span>[<span class="string">"1"</span>, <span class="string">"2"</span>, <span class="string">"3"</span>]); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>dict = PrimitiveDictionaryBuilder::<Int32Type, UInt16Type>::new(); |
| dict.extend([<span class="prelude-val">Some</span>(<span class="number">1</span>), <span class="prelude-val">Some</span>(<span class="number">1</span>), <span class="prelude-val">Some</span>(<span class="number">2</span>), <span class="prelude-val">Some</span>(<span class="number">3</span>), <span class="prelude-val">Some</span>(<span class="number">2</span>)]); |
| <span class="kw">let </span>dict = dict.finish(); |
| |
| <span class="kw">let </span>r = to_string(<span class="kw-2">&</span>dict).unwrap(); |
| <span class="kw">let </span>r = r.as_dictionary::<Int32Type>().downcast_dict::<StringArray>().unwrap(); |
| <span class="macro">assert_eq!</span>(r.keys(), dict.keys()); <span class="comment">// Keys are the same |
| |
| </span><span class="kw">let </span>actual = r.into_iter().map(Option::unwrap).collect::<Vec<<span class="kw">_</span>>>(); |
| <span class="macro">assert_eq!</span>(actual, <span class="kw-2">&</span>[<span class="string">"1"</span>, <span class="string">"1"</span>, <span class="string">"2"</span>, <span class="string">"3"</span>, <span class="string">"2"</span>]);</code></pre></div> |
| <p>See <a href="../cast/trait.AsArray.html#tymethod.as_any_dictionary_opt" title="method arrow_array::cast::AsArray::as_any_dictionary_opt"><code>AsArray::as_any_dictionary_opt</code></a> and <a href="../cast/trait.AsArray.html#method.as_any_dictionary" title="method arrow_array::cast::AsArray::as_any_dictionary"><code>AsArray::as_any_dictionary</code></a></p> |
| </div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.keys" class="method"><a class="src rightside" href="../../src/arrow_array/array/dictionary_array.rs.html#1008">Source</a><h4 class="code-header">fn <a href="#tymethod.keys" class="fn">keys</a>(&self) -> &dyn <a class="trait" href="trait.Array.html" title="trait arrow_array::array::Array">Array</a></h4></section></summary><div class="docblock"><p>Returns the primitive keys of this dictionary as an <a href="trait.Array.html" title="trait arrow_array::array::Array"><code>Array</code></a></p> |
| </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.values" class="method"><a class="src rightside" href="../../src/arrow_array/array/dictionary_array.rs.html#1011">Source</a><h4 class="code-header">fn <a href="#tymethod.values" class="fn">values</a>(&self) -> &<a class="type" href="type.ArrayRef.html" title="type arrow_array::array::ArrayRef">ArrayRef</a></h4></section></summary><div class="docblock"><p>Returns the values of this dictionary</p> |
| </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.normalized_keys" class="method"><a class="src rightside" href="../../src/arrow_array/array/dictionary_array.rs.html#1021">Source</a><h4 class="code-header">fn <a href="#tymethod.normalized_keys" class="fn">normalized_keys</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></h4></section></summary><div class="docblock"><p>Returns the keys of this dictionary as usize</p> |
| <p>The values for nulls will be arbitrary, but are guaranteed |
| to be in the range <code>0..self.values.len()</code></p> |
| <h5 id="panic"><a class="doc-anchor" href="#panic">§</a>Panic</h5> |
| <p>Panics if <code>values.len() == 0</code></p> |
| </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.with_values" class="method"><a class="src rightside" href="../../src/arrow_array/array/dictionary_array.rs.html#1026">Source</a><h4 class="code-header">fn <a href="#tymethod.with_values" class="fn">with_values</a>(&self, values: <a class="type" href="type.ArrayRef.html" title="type arrow_array::array::ArrayRef">ArrayRef</a>) -> <a class="type" href="type.ArrayRef.html" title="type arrow_array::array::ArrayRef">ArrayRef</a></h4></section></summary><div class="docblock"><p>Create a new <a href="struct.DictionaryArray.html" title="struct arrow_array::array::DictionaryArray"><code>DictionaryArray</code></a> replacing <code>values</code> with the new values</p> |
| <p>See <a href="struct.DictionaryArray.html#method.with_values" title="method arrow_array::array::DictionaryArray::with_values"><code>DictionaryArray::with_values</code></a></p> |
| </div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-AnyDictionaryArray-for-DictionaryArray%3CK%3E" class="impl"><a class="src rightside" href="../../src/arrow_array/array/dictionary_array.rs.html#1029-1048">Source</a><a href="#impl-AnyDictionaryArray-for-DictionaryArray%3CK%3E" class="anchor">§</a><h3 class="code-header">impl<K: <a class="trait" href="../types/trait.ArrowDictionaryKeyType.html" title="trait arrow_array::types::ArrowDictionaryKeyType">ArrowDictionaryKeyType</a>> <a class="trait" href="trait.AnyDictionaryArray.html" title="trait arrow_array::array::AnyDictionaryArray">AnyDictionaryArray</a> for <a class="struct" href="struct.DictionaryArray.html" title="struct arrow_array::array::DictionaryArray">DictionaryArray</a><K></h3></section></div><script src="../../trait.impl/arrow_array/array/dictionary_array/trait.AnyDictionaryArray.js" async></script></section></div></main></body></html> |
