| <!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 utility trait to help user to traverse against parquet type."><title>TypeVisitor in parquet::schema::visitor - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="parquet" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0-nightly (8c127df75 2024-05-16)" data-channel="nightly" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../parquet/index.html">parquet</a><span class="version">51.0.0</span></h2></div><h2 class="location"><a href="#">TypeVisitor</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.visit_list_with_item">visit_list_with_item</a></li><li><a href="#tymethod.visit_map">visit_map</a></li><li><a href="#tymethod.visit_primitive">visit_primitive</a></li><li><a href="#tymethod.visit_struct">visit_struct</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.dispatch">dispatch</a></li><li><a href="#method.visit_list">visit_list</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In parquet::schema::visitor</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../../index.html">parquet</a>::<wbr><a href="../index.html">schema</a>::<wbr><a href="index.html">visitor</a>::<wbr><a class="trait" href="#">TypeVisitor</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../../src/parquet/schema/visitor.rs.html#24-123">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait TypeVisitor<R, C> { |
| // Required methods |
| fn <a href="#tymethod.visit_primitive" class="fn">visit_primitive</a>( |
| &mut self, |
| primitive_type: <a class="type" href="../types/type.TypePtr.html" title="type parquet::schema::types::TypePtr">TypePtr</a>, |
| context: C |
| ) -> <a class="type" href="../../errors/type.Result.html" title="type parquet::errors::Result">Result</a><R>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.visit_struct" class="fn">visit_struct</a>(&mut self, struct_type: <a class="type" href="../types/type.TypePtr.html" title="type parquet::schema::types::TypePtr">TypePtr</a>, context: C) -> <a class="type" href="../../errors/type.Result.html" title="type parquet::errors::Result">Result</a><R>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.visit_map" class="fn">visit_map</a>(&mut self, map_type: <a class="type" href="../types/type.TypePtr.html" title="type parquet::schema::types::TypePtr">TypePtr</a>, context: C) -> <a class="type" href="../../errors/type.Result.html" title="type parquet::errors::Result">Result</a><R>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.visit_list_with_item" class="fn">visit_list_with_item</a>( |
| &mut self, |
| list_type: <a class="type" href="../types/type.TypePtr.html" title="type parquet::schema::types::TypePtr">TypePtr</a>, |
| item_type: <a class="type" href="../types/type.TypePtr.html" title="type parquet::schema::types::TypePtr">TypePtr</a>, |
| context: C |
| ) -> <a class="type" href="../../errors/type.Result.html" title="type parquet::errors::Result">Result</a><R>; |
| |
| // Provided methods |
| fn <a href="#method.visit_list" class="fn">visit_list</a>(&mut self, list_type: <a class="type" href="../types/type.TypePtr.html" title="type parquet::schema::types::TypePtr">TypePtr</a>, context: C) -> <a class="type" href="../../errors/type.Result.html" title="type parquet::errors::Result">Result</a><R> { ... } |
| <span class="item-spacer"></span> fn <a href="#method.dispatch" class="fn">dispatch</a>(&mut self, cur_type: <a class="type" href="../types/type.TypePtr.html" title="type parquet::schema::types::TypePtr">TypePtr</a>, context: C) -> <a class="type" href="../../errors/type.Result.html" title="type parquet::errors::Result">Result</a><R> { ... } |
| }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A utility trait to help user to traverse against parquet type.</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.visit_primitive" class="method"><a class="src rightside" href="../../../src/parquet/schema/visitor.rs.html#26">source</a><h4 class="code-header">fn <a href="#tymethod.visit_primitive" class="fn">visit_primitive</a>(&mut self, primitive_type: <a class="type" href="../types/type.TypePtr.html" title="type parquet::schema::types::TypePtr">TypePtr</a>, context: C) -> <a class="type" href="../../errors/type.Result.html" title="type parquet::errors::Result">Result</a><R></h4></section></summary><div class="docblock"><p>Called when a primitive type hit.</p> |
| </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.visit_struct" class="method"><a class="src rightside" href="../../../src/parquet/schema/visitor.rs.html#96">source</a><h4 class="code-header">fn <a href="#tymethod.visit_struct" class="fn">visit_struct</a>(&mut self, struct_type: <a class="type" href="../types/type.TypePtr.html" title="type parquet::schema::types::TypePtr">TypePtr</a>, context: C) -> <a class="type" href="../../errors/type.Result.html" title="type parquet::errors::Result">Result</a><R></h4></section></summary><div class="docblock"><p>Called when a struct type hit.</p> |
| </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.visit_map" class="method"><a class="src rightside" href="../../../src/parquet/schema/visitor.rs.html#99">source</a><h4 class="code-header">fn <a href="#tymethod.visit_map" class="fn">visit_map</a>(&mut self, map_type: <a class="type" href="../types/type.TypePtr.html" title="type parquet::schema::types::TypePtr">TypePtr</a>, context: C) -> <a class="type" href="../../errors/type.Result.html" title="type parquet::errors::Result">Result</a><R></h4></section></summary><div class="docblock"><p>Called when a map type hit.</p> |
| </div></details><details class="toggle method-toggle" open><summary><section id="tymethod.visit_list_with_item" class="method"><a class="src rightside" href="../../../src/parquet/schema/visitor.rs.html#117-122">source</a><h4 class="code-header">fn <a href="#tymethod.visit_list_with_item" class="fn">visit_list_with_item</a>( |
| &mut self, |
| list_type: <a class="type" href="../types/type.TypePtr.html" title="type parquet::schema::types::TypePtr">TypePtr</a>, |
| item_type: <a class="type" href="../types/type.TypePtr.html" title="type parquet::schema::types::TypePtr">TypePtr</a>, |
| context: C |
| ) -> <a class="type" href="../../errors/type.Result.html" title="type parquet::errors::Result">Result</a><R></h4></section></summary><div class="docblock"><p>Called by <code>visit_list</code>.</p> |
| </div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.visit_list" class="method"><a class="src rightside" href="../../../src/parquet/schema/visitor.rs.html#49-93">source</a><h4 class="code-header">fn <a href="#method.visit_list" class="fn">visit_list</a>(&mut self, list_type: <a class="type" href="../types/type.TypePtr.html" title="type parquet::schema::types::TypePtr">TypePtr</a>, context: C) -> <a class="type" href="../../errors/type.Result.html" title="type parquet::errors::Result">Result</a><R></h4></section></summary><div class="docblock"><p>Default implementation when visiting a list.</p> |
| <p>It checks list type definition and calls <a href="trait.TypeVisitor.html#tymethod.visit_list_with_item"><code>Self::visit_list_with_item</code></a> with extracted |
| item type.</p> |
| <p>To fully understand this algorithm, please refer to |
| <a href="https://github.com/apache/parquet-format/blob/master/LogicalTypes.md">parquet doc</a>.</p> |
| <p>For example, a standard list type looks like:</p> |
| <div class="example-wrap"><pre class="language-text"><code>required/optional group my_list (LIST) { |
| </code></pre></div> |
| <p>In such a case, <a href="trait.TypeVisitor.html#tymethod.visit_list_with_item"><code>Self::visit_list_with_item</code></a> will be called with <code>my_list</code> as the list |
| type, and <code>element</code> as the <code>item_type</code></p> |
| </div></details><details class="toggle method-toggle" open><summary><section id="method.dispatch" class="method"><a class="src rightside" href="../../../src/parquet/schema/visitor.rs.html#102-114">source</a><h4 class="code-header">fn <a href="#method.dispatch" class="fn">dispatch</a>(&mut self, cur_type: <a class="type" href="../types/type.TypePtr.html" title="type parquet::schema::types::TypePtr">TypePtr</a>, context: C) -> <a class="type" href="../../errors/type.Result.html" title="type parquet::errors::Result">Result</a><R></h4></section></summary><div class="docblock"><p>A utility method which detects input type and calls corresponding method.</p> |
| </div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../../trait.impl/parquet/schema/visitor/trait.TypeVisitor.js" async></script></section></div></main></body></html> |
