|
|
|
|
|
<!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="API documentation for the Rust `Parser` trait in crate `syn`."><meta name="keywords" content="rust, rustlang, rust-lang, Parser"><title>syn::parse::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="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../syn/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait Parser</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Output">Output</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.parse2">parse2</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.parse">parse</a><a href="#method.parse_str">parse_str</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>syn</a>::<wbr><a href='index.html'>parse</a></p><script>window.sidebarCurrent = {name: 'Parser', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><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><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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/syn/parse.rs.html#1058-1101' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>syn</a>::<wbr><a href='index.html'>parse</a>::<wbr><a class="trait" href=''>Parser</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Parser: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
|
|
|
|
type <a href='#associatedtype.Output' class="type">Output</a>;
|
|
|
|
|
|
fn <a href='#tymethod.parse2' class='fnname'>parse2</a>(self, tokens: <a class="struct" href="../../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>) -> <a class="type" href="../../syn/parse/type.Result.html" title="type syn::parse::Result">Result</a><Self::<a class="type" href="../../syn/parse/trait.Parser.html#associatedtype.Output" title="type syn::parse::Parser::Output">Output</a>>;
|
|
|
|
|
|
|
|
|
|
|
|
fn <a href='#method.parse' class='fnname'>parse</a>(self, tokens: <a class="struct" href="https://doc.rust-lang.org/nightly/proc_macro/struct.TokenStream.html" title="struct proc_macro::TokenStream">TokenStream</a>) -> <a class="type" href="../../syn/parse/type.Result.html" title="type syn::parse::Result">Result</a><Self::<a class="type" href="../../syn/parse/trait.Parser.html#associatedtype.Output" title="type syn::parse::Parser::Output">Output</a>> { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.parse_str' class='fnname'>parse_str</a>(self, s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="type" href="../../syn/parse/type.Result.html" title="type syn::parse::Result">Result</a><Self::<a class="type" href="../../syn/parse/trait.Parser.html#associatedtype.Output" title="type syn::parse::Parser::Output">Output</a>> { ... }
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Parser that can parse Rust tokens into a particular syntax tree node.</p>
|
|
|
|
|
|
<p>Refer to the <a href="index.html">module documentation</a> for details about parsing in Syn.</p>
|
|
|
|
|
|
<p><em>This trait is available if Syn is built with the <code>"parsing"</code> feature.</em></p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Output' class='method'><code id='Output.t'>type <a href='#associatedtype.Output' class="type">Output</a></code></h3></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.parse2' class='method'><code id='parse2.v'>fn <a href='#tymethod.parse2' class='fnname'>parse2</a>(self, tokens: <a class="struct" href="../../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>) -> <a class="type" href="../../syn/parse/type.Result.html" title="type syn::parse::Result">Result</a><Self::<a class="type" href="../../syn/parse/trait.Parser.html#associatedtype.Output" title="type syn::parse::Parser::Output">Output</a>></code></h3><div class='docblock'><p>Parse a proc-macro2 token stream into the chosen syntax tree node.</p>
|
|
|
|
|
|
<p>This function will check that the input is fully parsed. If there are
|
|
|
|
|
|
any unparsed tokens at the end of the stream, an error is returned.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.parse' class='method'><code id='parse.v'>fn <a href='#method.parse' class='fnname'>parse</a>(self, tokens: <a class="struct" href="https://doc.rust-lang.org/nightly/proc_macro/struct.TokenStream.html" title="struct proc_macro::TokenStream">TokenStream</a>) -> <a class="type" href="../../syn/parse/type.Result.html" title="type syn::parse::Result">Result</a><Self::<a class="type" href="../../syn/parse/trait.Parser.html#associatedtype.Output" title="type syn::parse::Parser::Output">Output</a>></code></h3><div class='docblock'><p>Parse tokens of source code into the chosen syntax tree node.</p>
|
|
|
|
|
|
<p>This function will check that the input is fully parsed. If there are
|
|
|
|
|
|
any unparsed tokens at the end of the stream, an error is returned.</p>
|
|
|
|
|
|
<p><em>This method is available if Syn is built with both the <code>"parsing"</code> and
|
|
|
|
|
|
<code>"proc-macro"</code> features.</em></p>
|
|
|
|
|
|
</div><h3 id='method.parse_str' class='method'><code id='parse_str.v'>fn <a href='#method.parse_str' class='fnname'>parse_str</a>(self, s: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="type" href="../../syn/parse/type.Result.html" title="type syn::parse::Result">Result</a><Self::<a class="type" href="../../syn/parse/trait.Parser.html#associatedtype.Output" title="type syn::parse::Parser::Output">Output</a>></code></h3><div class='docblock'><p>Parse a string of Rust code into the chosen syntax tree node.</p>
|
|
|
|
|
|
<p>This function will check that the input is fully parsed. If there are
|
|
|
|
|
|
any unparsed tokens at the end of the string, an error is returned.</p>
|
|
|
|
|
|
<h1 id="hygiene" class="section-header"><a href="#hygiene">Hygiene</a></h1>
|
|
|
|
|
|
<p>Every span in the resulting syntax tree will be set to resolve at the
|
|
|
|
|
|
macro call site.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-Parser' class='impl'><code class='in-band'>impl<F, T> Parser for F <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="type" href="../../syn/parse/type.ParseStream.html" title="type syn::parse::ParseStream">ParseStream</a>) -> <a class="type" href="../../syn/parse/type.Result.html" title="type syn::parse::Result">Result</a><T>, </span></code><a href='#impl-Parser' class='anchor'></a><a class='srclink' href='../../src/syn/parse.rs.html#1110-1142' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Output-1' class="type"><code id='Output.t-1'>type <a href='#associatedtype.Output-1' class="type">Output</a> = T</code></h4><h4 id='method.parse2' class="method hidden"><code id='parse2.v-1'>fn <a href='#method.parse2' class='fnname'>parse2</a>(self, tokens: <a class="struct" href="../../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>) -> <a class="type" href="../../syn/parse/type.Result.html" title="type syn::parse::Result">Result</a><T></code><a class='srclink' href='../../src/syn/parse.rs.html#1116-1126' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|
|
|
|
|
src="../../implementors/syn/parse/trait.Parser.js">
|
|
|
|
|
|
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "syn";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
