| <!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="Parquet schema parser. Provides methods to parse and validate string message type into Parquet `Type`."><title>parquet::schema::parser - 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 (b92758a9a 2024-05-20)" 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 mod"><!--[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="#">Module parser</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In parquet::schema</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>Module <a href="../../index.html">parquet</a>::<wbr><a href="../index.html">schema</a>::<wbr><a class="mod" href="#">parser</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/parser.rs.html#18-1125">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parquet schema parser. |
| Provides methods to parse and validate string message type into Parquet |
| <a href="../types/enum.Type.html" title="enum parquet::schema::types::Type"><code>Type</code></a>.</p> |
| <h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>parquet::schema::parser::parse_message_type; |
| |
| <span class="kw">let </span>message_type = <span class="string">" |
| message spark_schema { |
| OPTIONAL BYTE_ARRAY a (UTF8); |
| REQUIRED INT32 b; |
| REQUIRED DOUBLE c; |
| REQUIRED BOOLEAN d; |
| OPTIONAL group e (LIST) { |
| REPEATED group list { |
| REQUIRED INT32 element; |
| } |
| } |
| } |
| "</span>; |
| |
| <span class="kw">let </span>schema = parse_message_type(message_type).expect(<span class="string">"Expected valid schema"</span>); |
| <span class="macro">println!</span>(<span class="string">"{:?}"</span>, schema);</code></pre></div> |
| </div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Parser.html" title="struct parquet::schema::parser::Parser">Parser</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">Internal Schema parser. |
| Traverses message type using tokenizer and parses each group/primitive type |
| recursively.</div></li><li><div class="item-name"><a class="struct" href="struct.Tokenizer.html" title="struct parquet::schema::parser::Tokenizer">Tokenizer</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">Tokenizer to split message type string into tokens that are separated using characters |
| defined in <code>is_schema_delim</code> method. Tokenizer also preserves delimiters as tokens. |
| Tokenizer provides Iterator interface to process tokens; it also allows to step back |
| to reprocess previous tokens.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.assert_token.html" title="fn parquet::schema::parser::assert_token">assert_token</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.parse_bool.html" title="fn parquet::schema::parser::parse_bool">parse_bool</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.parse_i32.html" title="fn parquet::schema::parser::parse_i32">parse_i32</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.parse_message_type.html" title="fn parquet::schema::parser::parse_message_type">parse_message_type</a></div><div class="desc docblock-short">Parses message type as string into a Parquet <a href="../types/enum.Type.html" title="enum parquet::schema::types::Type"><code>Type</code></a> |
| which, for example, could be used to extract individual columns. Returns Parquet |
| general error when parsing or validation fails.</div></li><li><div class="item-name"><a class="fn" href="fn.parse_timeunit.html" title="fn parquet::schema::parser::parse_timeunit">parse_timeunit</a><span title="Restricted Visibility"> 🔒</span> </div></li></ul></section></div></main></body></html> |
