mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-29 15:04:32 +01:00
28 lines
4.8 KiB
HTML
28 lines
4.8 KiB
HTML
|
<!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 the content of a file of Rust code."><title>parse_file in syn - 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-492a78a4a87dcc01.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="syn" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.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-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.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 fn"><!--[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="../syn/index.html">syn</a><span class="version">1.0.109</span></h2></div><div class="sidebar-elems"></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>Function <a href="index.html">syn</a>::<wbr><a class="fn" href="#">parse_file</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/syn/lib.rs.html#960-984">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn parse_file(content: &<a class="primitive" href="https://doc.rust-lang.org/1.82.0/std/primitive.str.html">str</a>) -> <a class="type" href="parse/type.Result.html" title="type syn::parse::Result">Result</a><<a class="struct" href="struct.File.html" title="struct syn::File">File</a>></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parse the content of a file of Rust code.</p>
|
||
|
|
<p>This is different from <code>syn::parse_str::<File>(content)</code> in two ways:</p>
|
||
|
|
<ul>
|
||
|
|
<li>It discards a leading byte order mark <code>\u{FEFF}</code> if the file has one.</li>
|
||
|
|
<li>It preserves the shebang line of the file, such as <code>#!/usr/bin/env rustx</code>.</li>
|
||
|
|
</ul>
|
||
|
|
<p>If present, either of these would be an error using <code>from_str</code>.</p>
|
||
|
|
<p><em>This function is available only if Syn is built with the <code>"parsing"</code> and
|
||
|
|
<code>"full"</code> features.</em></p>
|
||
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::error::Error;
|
||
|
|
<span class="kw">use </span>std::fs::File;
|
||
|
|
<span class="kw">use </span>std::io::Read;
|
||
|
|
|
||
|
|
<span class="kw">fn </span>run() -> <span class="prelude-ty">Result</span><(), Box<Error>> {
|
||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>file = File::open(<span class="string">"path/to/code.rs"</span>)<span class="question-mark">?</span>;
|
||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>content = String::new();
|
||
|
|
file.read_to_string(<span class="kw-2">&mut </span>content)<span class="question-mark">?</span>;
|
||
|
|
|
||
|
|
<span class="kw">let </span>ast = syn::parse_file(<span class="kw-2">&</span>content)<span class="question-mark">?</span>;
|
||
|
|
<span class="kw">if let </span><span class="prelude-val">Some</span>(shebang) = ast.shebang {
|
||
|
|
<span class="macro">println!</span>(<span class="string">"{}"</span>, shebang);
|
||
|
|
}
|
||
|
|
<span class="macro">println!</span>(<span class="string">"{} items"</span>, ast.items.len());
|
||
|
|
|
||
|
|
<span class="prelude-val">Ok</span>(())
|
||
|
|
}</code></pre></div>
|
||
|
|
</div></details></section></div></main></body></html>
|