|
|
|
|
|
<!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 `Synom` trait in crate `syn`."><meta name="keywords" content="rust, rustlang, rust-lang, Synom"><title>syn::synom::Synom - 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 Synom</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.parse">parse</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.description">description</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Synom-for-TokenStream">TokenStream</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'>synom</a></p><script>window.sidebarCurrent = {name: 'Synom', 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/synom.rs.html#167-202' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>syn</a>::<wbr><a href='index.html'>synom</a>::<wbr><a class="trait" href=''>Synom</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Synom: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
|
|
|
|
fn <a href='#tymethod.parse' class='fnname'>parse</a>(input: <a class="struct" href="../../syn/buffer/struct.Cursor.html" title="struct syn::buffer::Cursor">Cursor</a>) -> <a class="type" href="../../syn/synom/type.PResult.html" title="type syn::synom::PResult">PResult</a><Self>;
|
|
|
|
|
|
|
|
|
|
|
|
fn <a href='#method.description' class='fnname'>description</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>> { ... }
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Parsing interface implemented by all types that can be parsed in a default
|
|
|
|
|
|
way from a token stream.</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='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.parse' class='method'><code id='parse.v'>fn <a href='#tymethod.parse' class='fnname'>parse</a>(input: <a class="struct" href="../../syn/buffer/struct.Cursor.html" title="struct syn::buffer::Cursor">Cursor</a>) -> <a class="type" href="../../syn/synom/type.PResult.html" title="type syn::synom::PResult">PResult</a><Self></code></h3></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.description' class='method'><code id='description.v'>fn <a href='#method.description' class='fnname'>description</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>></code></h3><div class='docblock'><p>A short name of the type being parsed.</p>
|
|
|
|
|
|
<p>The description should only be used for a simple name. It should not
|
|
|
|
|
|
contain newlines or sentence-ending punctuation, to facilitate embedding in
|
|
|
|
|
|
larger user-facing strings. Syn will use this description when building
|
|
|
|
|
|
error messages about parse failures.</p>
|
|
|
|
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">struct</span> <span class="ident">ExprMacro</span> {
|
|
|
|
|
|
<span class="comment">// ...</span>
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">impl</span> <span class="ident">Synom</span> <span class="kw">for</span> <span class="ident">ExprMacro</span> {
|
|
|
|
|
|
<span class="comment">// fn parse(...) -> ... { ... }</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">fn</span> <span class="ident">description</span>() <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span><span class="op">></span> {
|
|
|
|
|
|
<span class="comment">// Will result in messages like</span>
|
|
|
|
|
|
<span class="comment">//</span>
|
|
|
|
|
|
<span class="comment">// "failed to parse macro invocation expression: $reason"</span>
|
|
|
|
|
|
<span class="prelude-val">Some</span>(<span class="string">"macro invocation expression"</span>)
|
|
|
|
|
|
}
|
|
|
|
|
|
}</pre></div>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-Synom-for-TokenStream' class='impl'><code class='in-band'>impl <a class="trait" href="../../syn/synom/trait.Synom.html" title="trait syn::synom::Synom">Synom</a> for <a class="struct" href="../../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a></code><a href='#impl-Synom-for-TokenStream' class='anchor'></a><a class='srclink' href='../../src/syn/synom.rs.html#204-212' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.parse' class="method hidden"><code id='parse.v-1'>fn <a href='#method.parse' class='fnname'>parse</a>(input: <a class="struct" href="../../syn/buffer/struct.Cursor.html" title="struct syn::buffer::Cursor">Cursor</a>) -> <a class="type" href="../../syn/synom/type.PResult.html" title="type syn::synom::PResult">PResult</a><Self></code><a class='srclink' href='../../src/syn/synom.rs.html#205-207' title='goto source code'>[src]</a></h4><h4 id='method.description-1' class="method hidden"><code id='description.v-1'>fn <a href='#method.description' class='fnname'>description</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>></code><a class='srclink' href='../../src/syn/synom.rs.html#209-211' title='goto source code'>[src]</a></h4></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-Synom' class='impl'><code class='in-band'>impl Synom for <a class="enum" href="../../syn/enum.BareFnArgName.html" title="enum syn::BareFnArgName">BareFnArgName</a></code><a href='#impl-Synom' class='anchor'></a><a class='srclink' href='../../src/syn/ty.rs.html#613-623' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.parse-1' class="method hidden"><code id='parse.v-2'>fn <a href='#method.parse-1' class='fnname'>parse</a>(i: <a class="struct" href="../../syn/buffer/struct.Cursor.html" title="struct syn::buffer::Cursor">Cursor</a>) -> <a class="type" href="../../syn/synom/type.PResult.html" title="type syn::synom::PResult">PResult</a><Self></code><a class='srclink' href='../../src/syn/parsers.rs.html#68-70' title='goto source code'>[src]</a></h4><h4 id='method.description-2' class="method hidden"><code id='description.v-2'>fn <a href='#method.description-2' class='fnname'>description</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>></code><a class='srclink' href='../../src/syn/ty.rs.html#620-622' title='goto source code'>[src]</a></h4></div><h3 id='impl-Synom-1' class='impl'><code class='in-band'>impl Synom for <a class="enum" href="../../syn/enum.Expr.html" title="enum syn::Expr">Expr</a></code><a href='#impl-Synom-1' class='anchor'></a><a class='srclink' href='../../src/syn/expr.rs.html#1058-1064' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.parse-2' class="method hidden"><code id='parse.v-3'>fn <a href='#method.parse-2' class='fnname'>parse</a>(i: <a class="struct" href="../../syn/buffer/struct.Cursor.html" title="struct syn::buffer::Cursor">Cursor</a>) -> <a class="type" href="../../syn/synom/type.PResult.html" title="type syn::synom::PResult">PResult</a><Self></code><a class='srclink' href='../../src/syn/parsers.rs.html#68-70' title='goto source code'>[src]</a></h4><h4 id='method.description-3' class="method hidden"><code id='description.v-3'>fn <a href='#method.description-3' class='fnname'>description</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'static <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>></code><a class='srclink' href='../../src/syn/expr.rs.html#1061-1063' title='goto source code'>[src]</a></h4></div><h3 id='impl-Synom-2' class='impl'><code class='in-band'>impl Synom for <a class="enum" href="../../syn/enum.GenericArgument.html" title="enum syn::GenericArgument">GenericArgument</a></code><a href='#impl-Synom-2' class='anchor'></a><a class='srclink' href='../../src/syn/path.rs.html#247-255' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.parse-3' class="method hidden"><code id='parse.v-4'>fn <a href='#method.parse-3' class='fnname'>parse</a>(i: <a class="struct" href="../../syn/buffer/struct.Cursor.html" title="struct syn::buffer::Cursor">Cursor</a>) -> <a class="type" href="../../syn/synom/type.PResult.html" title="type syn::synom::PResult">PResult</a><Self></code><a class='srclink' href='../../src/syn/parsers.rs.html#68-70' title='goto source code'>[src]</a></h4></div><h3 id='impl-Synom-3' class='impl'><code class='in-band'>impl Synom for <a class="enum" href="../../syn/enum.GenericParam.html" title="enum syn::GenericParam">GenericParam</a></code><a href='#impl-Synom-3' class='anchor'></a><a class='srclink' href='../../src/syn/generics.rs.html#512-524' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.parse-4' class="method hidden"><code id='parse.v-5'>fn <a href='#method.parse-4' class='fnname'>parse</a>(i: <a class="struct"
|
|
|
|
|
|
src="../../implementors/syn/synom/trait.Synom.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>
|
