forked from argotorg/fe
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathfn.parse_file.html
More file actions
13 lines (13 loc) · 5.34 KB
/
Copy pathfn.parse_file.html
File metadata and controls
13 lines (13 loc) · 5.34 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
<!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="Parse a [`Module`] from the file content string."><meta name="keywords" content="rust, rustlang, rust-lang, parse_file"><title>parse_file in fe_parser - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../fe_parser/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><h2 class="location">Other items in<br><a href="index.html">fe_parser</a></h2><div id="sidebar-vars" data-name="parse_file" data-ty="fn" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Function <a href="index.html">fe_parser</a>::<wbr><a class="fn" href="#">parse_file</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/fe_parser/lib.rs.html#26-30" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust fn"><code>pub fn parse_file(file_id: <a class="struct" href="../fe_common/files/struct.SourceFileId.html" title="struct fe_common::files::SourceFileId">SourceFileId</a>, src: &<a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.tuple.html">(</a><a class="struct" href="ast/struct.Module.html" title="struct fe_parser::ast::Module">Module</a>, <a class="struct" href="https://doc.rust-lang.org/1.58.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../fe_common/diagnostics/struct.Diagnostic.html" title="struct fe_common::diagnostics::Diagnostic">Diagnostic</a>><a class="primitive" href="https://doc.rust-lang.org/1.58.1/std/primitive.tuple.html">)</a></code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parse a <a href="ast/struct.Module.html" title="Module"><code>Module</code></a> from the file content string.</p>
<p>Returns a <code>Module</code> (which may be incomplete), and a vec of <a href="../fe_common/diagnostics/struct.Diagnostic.html" title="Diagnostic"><code>Diagnostic</code></a>s
(which may be empty) to display to the user. If any of the returned
diagnostics are errors, the compilation of this file should ultimately fail.</p>
<p>If a fatal parse error occurred, the last element of the <code>Module::body</code> will
be a <code>ModuleStmt::ParseError</code>. The parser currently has very limited ability
to recover from syntax errors; this is just a first meager attempt at returning a
useful AST when there are syntax errors.</p>
<p>A <a href="../fe_common/files/struct.SourceFileId.html" title="SourceFileId"><code>SourceFileId</code></a> is required to associate any diagnostics with the
underlying file.</p>
</div></details></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="fe_parser" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
</body></html>