414 lines
75 KiB
HTML
414 lines
75 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="Cursor position within a buffered token stream."><meta name="keywords" content="rust, rustlang, rust-lang, ParseBuffer"><title>ParseBuffer in syn::parse - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.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"></head><body class="rustdoc struct"><!--[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">☰</button><a class="sidebar-logo" href="../../syn/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../syn/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">ParseBuffer</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><ul><li><a href="#method.call">call</a></li><li><a href="#method.cursor">cursor</a></li><li><a href="#method.error">error</a></li><li><a href="#method.fork">fork</a></li><li><a href="#method.is_empty">is_empty</a></li><li><a href="#method.lookahead1">lookahead1</a></li><li><a href="#method.parse">parse</a></li><li><a href="#method.parse_terminated">parse_terminated</a></li><li><a href="#method.peek">peek</a></li><li><a href="#method.peek2">peek2</a></li><li><a href="#method.peek3">peek3</a></li><li><a href="#method.span">span</a></li><li><a href="#method.step">step</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><ul><li><a href="#impl-Debug-for-ParseBuffer%3C%27a%3E">Debug</a></li><li><a href="#impl-Display-for-ParseBuffer%3C%27a%3E">Display</a></li><li><a href="#impl-Drop-for-ParseBuffer%3C%27a%3E">Drop</a></li><li><a href="#impl-Speculative-for-ParseBuffer%3C%27a%3E">Speculative</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul><li><a href="#impl-RefUnwindSafe-for-ParseBuffer%3C%27a%3E">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-ParseBuffer%3C%27a%3E">!Send</a></li><li><a href="#impl-Sync-for-ParseBuffer%3C%27a%3E">!Sync</a></li><li><a href="#impl-Unpin-for-ParseBuffer%3C%27a%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ParseBuffer%3C%27a%3E">!UnwindSafe</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><ul><li><a href="#impl-Any-for-ParseBuffer%3C%27a%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-ParseBuffer%3C%27a%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-ParseBuffer%3C%27a%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-ParseBuffer%3C%27a%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-ParseBuffer%3C%27a%3E">Into<U></a></li><li><a href="#impl-ToString-for-ParseBuffer%3C%27a%3E">ToString</a></li><li><a href="#impl-TryFrom%3CU%3E-for-ParseBuffer%3C%27a%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-ParseBuffer%3C%27a%3E">TryInto<U></a></li></ul></div></section><h2 class="location"><a href="index.html">In syn::parse</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../syn/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Struct <a href="../index.html">syn</a>::<wbr><a href="index.html">parse</a>::<wbr><a class="struct" href="#">ParseBuffer</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></h1><span class="out-of-band"><a class="srclink" href="../../src/syn/parse.rs.html#252-268">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust struct"><code>pub struct ParseBuffer<'a> { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Cursor position within a buffered token stream.</p>
|
||
<p>This type is more commonly used through the type alias <a href="type.ParseStream.html" title="ParseStream"><code>ParseStream</code></a> which
|
||
is an alias for <code>&ParseBuffer</code>.</p>
|
||
<p><code>ParseStream</code> is the input type for all parser functions in Syn. They have
|
||
the signature <code>fn(ParseStream) -> Result<T></code>.</p>
|
||
<h3 id="calling-a-parser-function"><a href="#calling-a-parser-function">Calling a parser function</a></h3>
|
||
<p>There is no public way to construct a <code>ParseBuffer</code>. Instead, if you are
|
||
looking to invoke a parser function that requires <code>ParseStream</code> as input,
|
||
you will need to go through one of the public parsing entry points.</p>
|
||
<ul>
|
||
<li>The <a href="../macro.parse_macro_input.html"><code>parse_macro_input!</code></a> macro if parsing input of a procedural macro;</li>
|
||
<li>One of <a href="index.html#the-synparse-functions">the <code>syn::parse*</code> functions</a>; or</li>
|
||
<li>A method of the <a href="trait.Parser.html" title="Parser"><code>Parser</code></a> trait.</li>
|
||
</ul>
|
||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-ParseBuffer%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#464-1063">source</a></span><a href="#impl-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="struct" href="struct.ParseBuffer.html" title="struct syn::parse::ParseBuffer">ParseBuffer</a><'a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#467-469">source</a></span><h4 class="code-header">pub fn <a href="#method.parse" class="fnname">parse</a><T: <a class="trait" href="trait.Parse.html" title="trait syn::parse::Parse">Parse</a>>(&self) -> <a class="type" href="type.Result.html" title="type syn::parse::Result">Result</a><T></h4></section></summary><div class="docblock"><p>Parses a syntax tree node of type <code>T</code>, advancing the position of our
|
||
parse stream past it.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.call" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#507-509">source</a></span><h4 class="code-header">pub fn <a href="#method.call" class="fnname">call</a><T>(&self, function: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.fn.html">fn</a>(_: <a class="type" href="type.ParseStream.html" title="type syn::parse::ParseStream">ParseStream</a><'_>) -> <a class="type" href="type.Result.html" title="type syn::parse::Result">Result</a><T>) -> <a class="type" href="type.Result.html" title="type syn::parse::Result">Result</a><T></h4></section></summary><div class="docblock"><p>Calls the given parser function to parse a syntax tree node of type <code>T</code>
|
||
from this stream.</p>
|
||
<h5 id="example"><a href="#example">Example</a></h5>
|
||
<p>The parser below invokes <a href="../struct.Attribute.html#method.parse_outer"><code>Attribute::parse_outer</code></a> to parse a vector of
|
||
zero or more outer attributes.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">syn</span>::{<span class="ident">Attribute</span>, <span class="ident">Ident</span>, <span class="prelude-ty">Result</span>, <span class="ident">Token</span>};
|
||
<span class="kw">use</span> <span class="ident">syn::parse</span>::{<span class="ident">Parse</span>, <span class="ident">ParseStream</span>};
|
||
|
||
<span class="comment">// Parses a unit struct with attributes.</span>
|
||
<span class="comment">//</span>
|
||
<span class="comment">// #[path = "s.tmpl"]</span>
|
||
<span class="comment">// struct S;</span>
|
||
<span class="kw">struct</span> <span class="ident">UnitStruct</span> {
|
||
<span class="ident">attrs</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">Attribute</span><span class="op">></span>,
|
||
<span class="ident">struct_token</span>: <span class="macro">Token!</span>[<span class="kw">struct</span>],
|
||
<span class="ident">name</span>: <span class="ident">Ident</span>,
|
||
<span class="ident">semi_token</span>: <span class="macro">Token!</span>[;],
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">Parse</span> <span class="kw">for</span> <span class="ident">UnitStruct</span> {
|
||
<span class="kw">fn</span> <span class="ident">parse</span>(<span class="ident">input</span>: <span class="ident">ParseStream</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span><span class="op">></span> {
|
||
<span class="prelude-val">Ok</span>(<span class="ident">UnitStruct</span> {
|
||
<span class="ident">attrs</span>: <span class="ident">input</span>.<span class="ident">call</span>(<span class="ident">Attribute::parse_outer</span>)<span class="question-mark">?</span>,
|
||
<span class="ident">struct_token</span>: <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>,
|
||
<span class="ident">name</span>: <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>,
|
||
<span class="ident">semi_token</span>: <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>,
|
||
})
|
||
}
|
||
}</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.peek" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#583-586">source</a></span><h4 class="code-header">pub fn <a href="#method.peek" class="fnname">peek</a><T: <a class="trait" href="trait.Peek.html" title="trait syn::parse::Peek">Peek</a>>(&self, token: T) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Looks at the next token in the parse stream to determine whether it
|
||
matches the requested type of token.</p>
|
||
<p>Does not advance the position of the parse stream.</p>
|
||
<h5 id="syntax"><a href="#syntax">Syntax</a></h5>
|
||
<p>Note that this method does not use turbofish syntax. Pass the peek type
|
||
inside of parentheses.</p>
|
||
<ul>
|
||
<li><code>input.peek(Token![struct])</code></li>
|
||
<li><code>input.peek(Token![==])</code></li>
|
||
<li><code>input.peek(Ident)</code> <em>(does not accept keywords)</em></li>
|
||
<li><code>input.peek(Ident::peek_any)</code></li>
|
||
<li><code>input.peek(Lifetime)</code></li>
|
||
<li><code>input.peek(token::Brace)</code></li>
|
||
</ul>
|
||
<h5 id="example-1"><a href="#example-1">Example</a></h5>
|
||
<p>In this example we finish parsing the list of supertraits when the next
|
||
token in the input is either <code>where</code> or an opening curly brace.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">syn</span>::{<span class="ident">braced</span>, <span class="ident">token</span>, <span class="ident">Generics</span>, <span class="ident">Ident</span>, <span class="prelude-ty">Result</span>, <span class="ident">Token</span>, <span class="ident">TypeParamBound</span>};
|
||
<span class="kw">use</span> <span class="ident">syn::parse</span>::{<span class="ident">Parse</span>, <span class="ident">ParseStream</span>};
|
||
<span class="kw">use</span> <span class="ident">syn::punctuated::Punctuated</span>;
|
||
|
||
<span class="comment">// Parses a trait definition containing no associated items.</span>
|
||
<span class="comment">//</span>
|
||
<span class="comment">// trait Marker<'de, T>: A + B<'de> where Box<T>: Clone {}</span>
|
||
<span class="kw">struct</span> <span class="ident">MarkerTrait</span> {
|
||
<span class="ident">trait_token</span>: <span class="macro">Token!</span>[<span class="kw">trait</span>],
|
||
<span class="ident">ident</span>: <span class="ident">Ident</span>,
|
||
<span class="ident">generics</span>: <span class="ident">Generics</span>,
|
||
<span class="ident">colon_token</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="macro">Token!</span>[:]<span class="op">></span>,
|
||
<span class="ident">supertraits</span>: <span class="ident">Punctuated</span><span class="op"><</span><span class="ident">TypeParamBound</span>, <span class="macro">Token!</span>[<span class="op">+</span>]<span class="op">></span>,
|
||
<span class="ident">brace_token</span>: <span class="ident">token::Brace</span>,
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">Parse</span> <span class="kw">for</span> <span class="ident">MarkerTrait</span> {
|
||
<span class="kw">fn</span> <span class="ident">parse</span>(<span class="ident">input</span>: <span class="ident">ParseStream</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">trait_token</span>: <span class="macro">Token!</span>[<span class="kw">trait</span>] <span class="op">=</span> <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> <span class="ident">ident</span>: <span class="ident">Ident</span> <span class="op">=</span> <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">generics</span>: <span class="ident">Generics</span> <span class="op">=</span> <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> <span class="ident">colon_token</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="macro">Token!</span>[:]<span class="op">></span> <span class="op">=</span> <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">supertraits</span> <span class="op">=</span> <span class="ident">Punctuated::new</span>();
|
||
<span class="kw">if</span> <span class="ident">colon_token</span>.<span class="ident">is_some</span>() {
|
||
<span class="kw">loop</span> {
|
||
<span class="ident">supertraits</span>.<span class="ident">push_value</span>(<span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>);
|
||
<span class="kw">if</span> <span class="ident">input</span>.<span class="ident">peek</span>(<span class="macro">Token!</span>[<span class="kw">where</span>]) <span class="op">|</span><span class="op">|</span> <span class="ident">input</span>.<span class="ident">peek</span>(<span class="ident">token::Brace</span>) {
|
||
<span class="kw">break</span>;
|
||
}
|
||
<span class="ident">supertraits</span>.<span class="ident">push_punct</span>(<span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>);
|
||
}
|
||
}
|
||
|
||
<span class="ident">generics</span>.<span class="ident">where_clause</span> <span class="op">=</span> <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> <span class="ident">content</span>;
|
||
<span class="kw">let</span> <span class="ident">empty_brace_token</span> <span class="op">=</span> <span class="macro">braced!</span>(<span class="ident">content</span> <span class="kw">in</span> <span class="ident">input</span>);
|
||
|
||
<span class="prelude-val">Ok</span>(<span class="ident">MarkerTrait</span> {
|
||
<span class="ident">trait_token</span>,
|
||
<span class="ident">ident</span>,
|
||
<span class="ident">generics</span>,
|
||
<span class="ident">colon_token</span>,
|
||
<span class="ident">supertraits</span>,
|
||
<span class="ident">brace_token</span>: <span class="ident">empty_brace_token</span>,
|
||
})
|
||
}
|
||
}</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.peek2" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#622-634">source</a></span><h4 class="code-header">pub fn <a href="#method.peek2" class="fnname">peek2</a><T: <a class="trait" href="trait.Peek.html" title="trait syn::parse::Peek">Peek</a>>(&self, token: T) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Looks at the second-next token in the parse stream.</p>
|
||
<p>This is commonly useful as a way to implement contextual keywords.</p>
|
||
<h5 id="example-2"><a href="#example-2">Example</a></h5>
|
||
<p>This example needs to use <code>peek2</code> because the symbol <code>union</code> is not a
|
||
keyword in Rust. We can’t use just <code>peek</code> and decide to parse a union if
|
||
the very next token is <code>union</code>, because someone is free to write a <code>mod union</code> and a macro invocation that looks like <code>union::some_macro! { ... }</code>. In other words <code>union</code> is a contextual keyword.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">syn</span>::{<span class="ident">Ident</span>, <span class="ident">ItemUnion</span>, <span class="ident">Macro</span>, <span class="prelude-ty">Result</span>, <span class="ident">Token</span>};
|
||
<span class="kw">use</span> <span class="ident">syn::parse</span>::{<span class="ident">Parse</span>, <span class="ident">ParseStream</span>};
|
||
|
||
<span class="comment">// Parses either a union or a macro invocation.</span>
|
||
<span class="kw">enum</span> <span class="ident">UnionOrMacro</span> {
|
||
<span class="comment">// union MaybeUninit<T> { uninit: (), value: T }</span>
|
||
<span class="ident">Union</span>(<span class="ident">ItemUnion</span>),
|
||
<span class="comment">// lazy_static! { ... }</span>
|
||
<span class="ident">Macro</span>(<span class="ident">Macro</span>),
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">Parse</span> <span class="kw">for</span> <span class="ident">UnionOrMacro</span> {
|
||
<span class="kw">fn</span> <span class="ident">parse</span>(<span class="ident">input</span>: <span class="ident">ParseStream</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span><span class="op">></span> {
|
||
<span class="kw">if</span> <span class="ident">input</span>.<span class="ident">peek</span>(<span class="macro">Token!</span>[<span class="ident">union</span>]) <span class="op">&&</span> <span class="ident">input</span>.<span class="ident">peek2</span>(<span class="ident">Ident</span>) {
|
||
<span class="ident">input</span>.<span class="ident">parse</span>().<span class="ident">map</span>(<span class="ident">UnionOrMacro::Union</span>)
|
||
} <span class="kw">else</span> {
|
||
<span class="ident">input</span>.<span class="ident">parse</span>().<span class="ident">map</span>(<span class="ident">UnionOrMacro::Macro</span>)
|
||
}
|
||
}
|
||
}</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.peek3" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#637-653">source</a></span><h4 class="code-header">pub fn <a href="#method.peek3" class="fnname">peek3</a><T: <a class="trait" href="trait.Peek.html" title="trait syn::parse::Peek">Peek</a>>(&self, token: T) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Looks at the third-next token in the parse stream.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.parse_terminated" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#699-704">source</a></span><h4 class="code-header">pub fn <a href="#method.parse_terminated" class="fnname">parse_terminated</a><T, P: <a class="trait" href="trait.Parse.html" title="trait syn::parse::Parse">Parse</a>>(<br> &self,<br> parser: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.fn.html">fn</a>(_: <a class="type" href="type.ParseStream.html" title="type syn::parse::ParseStream">ParseStream</a><'_>) -> <a class="type" href="type.Result.html" title="type syn::parse::Result">Result</a><T><br>) -> <a class="type" href="type.Result.html" title="type syn::parse::Result">Result</a><<a class="struct" href="../punctuated/struct.Punctuated.html" title="struct syn::punctuated::Punctuated">Punctuated</a><T, P>></h4></section></summary><div class="docblock"><p>Parses zero or more occurrences of <code>T</code> separated by punctuation of type
|
||
<code>P</code>, with optional trailing punctuation.</p>
|
||
<p>Parsing continues until the end of this parse stream. The entire content
|
||
of this parse stream must consist of <code>T</code> and <code>P</code>.</p>
|
||
<h5 id="example-3"><a href="#example-3">Example</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">syn</span>::{<span class="ident">parenthesized</span>, <span class="ident">token</span>, <span class="ident">Ident</span>, <span class="prelude-ty">Result</span>, <span class="ident">Token</span>, <span class="ident">Type</span>};
|
||
<span class="kw">use</span> <span class="ident">syn::parse</span>::{<span class="ident">Parse</span>, <span class="ident">ParseStream</span>};
|
||
<span class="kw">use</span> <span class="ident">syn::punctuated::Punctuated</span>;
|
||
|
||
<span class="comment">// Parse a simplified tuple struct syntax like:</span>
|
||
<span class="comment">//</span>
|
||
<span class="comment">// struct S(A, B);</span>
|
||
<span class="kw">struct</span> <span class="ident">TupleStruct</span> {
|
||
<span class="ident">struct_token</span>: <span class="macro">Token!</span>[<span class="kw">struct</span>],
|
||
<span class="ident">ident</span>: <span class="ident">Ident</span>,
|
||
<span class="ident">paren_token</span>: <span class="ident">token::Paren</span>,
|
||
<span class="ident">fields</span>: <span class="ident">Punctuated</span><span class="op"><</span><span class="ident">Type</span>, <span class="macro">Token!</span>[,]<span class="op">></span>,
|
||
<span class="ident">semi_token</span>: <span class="macro">Token!</span>[;],
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">Parse</span> <span class="kw">for</span> <span class="ident">TupleStruct</span> {
|
||
<span class="kw">fn</span> <span class="ident">parse</span>(<span class="ident">input</span>: <span class="ident">ParseStream</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">content</span>;
|
||
<span class="prelude-val">Ok</span>(<span class="ident">TupleStruct</span> {
|
||
<span class="ident">struct_token</span>: <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>,
|
||
<span class="ident">ident</span>: <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>,
|
||
<span class="ident">paren_token</span>: <span class="macro">parenthesized!</span>(<span class="ident">content</span> <span class="kw">in</span> <span class="ident">input</span>),
|
||
<span class="ident">fields</span>: <span class="ident">content</span>.<span class="ident">parse_terminated</span>(<span class="ident">Type::parse</span>)<span class="question-mark">?</span>,
|
||
<span class="ident">semi_token</span>: <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>,
|
||
})
|
||
}
|
||
}</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_empty" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#743-745">source</a></span><h4 class="code-header">pub fn <a href="#method.is_empty" class="fnname">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether there are tokens remaining in this stream.</p>
|
||
<p>This method returns true at the end of the content of a set of
|
||
delimiters, as well as at the very end of the complete macro input.</p>
|
||
<h5 id="example-4"><a href="#example-4">Example</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">syn</span>::{<span class="ident">braced</span>, <span class="ident">token</span>, <span class="ident">Ident</span>, <span class="ident">Item</span>, <span class="prelude-ty">Result</span>, <span class="ident">Token</span>};
|
||
<span class="kw">use</span> <span class="ident">syn::parse</span>::{<span class="ident">Parse</span>, <span class="ident">ParseStream</span>};
|
||
|
||
<span class="comment">// Parses a Rust `mod m { ... }` containing zero or more items.</span>
|
||
<span class="kw">struct</span> <span class="ident">Mod</span> {
|
||
<span class="ident">mod_token</span>: <span class="macro">Token!</span>[<span class="kw">mod</span>],
|
||
<span class="ident">name</span>: <span class="ident">Ident</span>,
|
||
<span class="ident">brace_token</span>: <span class="ident">token::Brace</span>,
|
||
<span class="ident">items</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">Item</span><span class="op">></span>,
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">Parse</span> <span class="kw">for</span> <span class="ident">Mod</span> {
|
||
<span class="kw">fn</span> <span class="ident">parse</span>(<span class="ident">input</span>: <span class="ident">ParseStream</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">content</span>;
|
||
<span class="prelude-val">Ok</span>(<span class="ident">Mod</span> {
|
||
<span class="ident">mod_token</span>: <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>,
|
||
<span class="ident">name</span>: <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>,
|
||
<span class="ident">brace_token</span>: <span class="macro">braced!</span>(<span class="ident">content</span> <span class="kw">in</span> <span class="ident">input</span>),
|
||
<span class="ident">items</span>: {
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">items</span> <span class="op">=</span> <span class="ident">Vec::new</span>();
|
||
<span class="kw">while</span> <span class="op">!</span><span class="ident">content</span>.<span class="ident">is_empty</span>() {
|
||
<span class="ident">items</span>.<span class="ident">push</span>(<span class="ident">content</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>);
|
||
}
|
||
<span class="ident">items</span>
|
||
},
|
||
})
|
||
}
|
||
}</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.lookahead1" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#788-790">source</a></span><h4 class="code-header">pub fn <a href="#method.lookahead1" class="fnname">lookahead1</a>(&self) -> <a class="struct" href="struct.Lookahead1.html" title="struct syn::parse::Lookahead1">Lookahead1</a><'a></h4></section></summary><div class="docblock"><p>Constructs a helper for peeking at the next token in this stream and
|
||
building an error message if it is not one of a set of expected tokens.</p>
|
||
<h5 id="example-5"><a href="#example-5">Example</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">syn</span>::{<span class="ident">ConstParam</span>, <span class="ident">Ident</span>, <span class="ident">Lifetime</span>, <span class="ident">LifetimeDef</span>, <span class="prelude-ty">Result</span>, <span class="ident">Token</span>, <span class="ident">TypeParam</span>};
|
||
<span class="kw">use</span> <span class="ident">syn::parse</span>::{<span class="ident">Parse</span>, <span class="ident">ParseStream</span>};
|
||
|
||
<span class="comment">// A generic parameter, a single one of the comma-separated elements inside</span>
|
||
<span class="comment">// angle brackets in:</span>
|
||
<span class="comment">//</span>
|
||
<span class="comment">// fn f<T: Clone, 'a, 'b: 'a, const N: usize>() { ... }</span>
|
||
<span class="comment">//</span>
|
||
<span class="comment">// On invalid input, lookahead gives us a reasonable error message.</span>
|
||
<span class="comment">//</span>
|
||
<span class="comment">// error: expected one of: identifier, lifetime, `const`</span>
|
||
<span class="comment">// |</span>
|
||
<span class="comment">// 5 | fn f<!Sized>() {}</span>
|
||
<span class="comment">// | ^</span>
|
||
<span class="kw">enum</span> <span class="ident">GenericParam</span> {
|
||
<span class="ident">Type</span>(<span class="ident">TypeParam</span>),
|
||
<span class="ident">Lifetime</span>(<span class="ident">LifetimeDef</span>),
|
||
<span class="ident">Const</span>(<span class="ident">ConstParam</span>),
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">Parse</span> <span class="kw">for</span> <span class="ident">GenericParam</span> {
|
||
<span class="kw">fn</span> <span class="ident">parse</span>(<span class="ident">input</span>: <span class="ident">ParseStream</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">lookahead</span> <span class="op">=</span> <span class="ident">input</span>.<span class="ident">lookahead1</span>();
|
||
<span class="kw">if</span> <span class="ident">lookahead</span>.<span class="ident">peek</span>(<span class="ident">Ident</span>) {
|
||
<span class="ident">input</span>.<span class="ident">parse</span>().<span class="ident">map</span>(<span class="ident">GenericParam::Type</span>)
|
||
} <span class="kw">else</span> <span class="kw">if</span> <span class="ident">lookahead</span>.<span class="ident">peek</span>(<span class="ident">Lifetime</span>) {
|
||
<span class="ident">input</span>.<span class="ident">parse</span>().<span class="ident">map</span>(<span class="ident">GenericParam::Lifetime</span>)
|
||
} <span class="kw">else</span> <span class="kw">if</span> <span class="ident">lookahead</span>.<span class="ident">peek</span>(<span class="macro">Token!</span>[<span class="kw">const</span>]) {
|
||
<span class="ident">input</span>.<span class="ident">parse</span>().<span class="ident">map</span>(<span class="ident">GenericParam::Const</span>)
|
||
} <span class="kw">else</span> {
|
||
<span class="prelude-val">Err</span>(<span class="ident">lookahead</span>.<span class="ident">error</span>())
|
||
}
|
||
}
|
||
}</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fork" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#918-927">source</a></span><h4 class="code-header">pub fn <a href="#method.fork" class="fnname">fork</a>(&self) -> Self</h4></section></summary><div class="docblock"><p>Forks a parse stream so that parsing tokens out of either the original
|
||
or the fork does not advance the position of the other.</p>
|
||
<h5 id="performance"><a href="#performance">Performance</a></h5>
|
||
<p>Forking a parse stream is a cheap fixed amount of work and does not
|
||
involve copying token buffers. Where you might hit performance problems
|
||
is if your macro ends up parsing a large amount of content more than
|
||
once.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="comment">// Do not do this.</span>
|
||
<span class="kw">if</span> <span class="ident">input</span>.<span class="ident">fork</span>().<span class="ident">parse</span>::<span class="op"><</span><span class="ident">Expr</span><span class="op">></span>().<span class="ident">is_ok</span>() {
|
||
<span class="kw">return</span> <span class="ident">input</span>.<span class="ident">parse</span>::<span class="op"><</span><span class="ident">Expr</span><span class="op">></span>();
|
||
}</code></pre></div>
|
||
<p>As a rule, avoid parsing an unbounded amount of tokens out of a forked
|
||
parse stream. Only use a fork when the amount of work performed against
|
||
the fork is small and bounded.</p>
|
||
<p>When complex speculative parsing against the forked stream is
|
||
unavoidable, use <a href="discouraged/trait.Speculative.html"><code>parse::discouraged::Speculative</code></a> to advance the
|
||
original stream once the fork’s parse is determined to have been
|
||
successful.</p>
|
||
<p>For a lower level way to perform speculative parsing at the token level,
|
||
consider using <a href="struct.ParseBuffer.html#method.step"><code>ParseStream::step</code></a> instead.</p>
|
||
<h5 id="example-6"><a href="#example-6">Example</a></h5>
|
||
<p>The parse implementation shown here parses possibly restricted <code>pub</code>
|
||
visibilities.</p>
|
||
<ul>
|
||
<li><code>pub</code></li>
|
||
<li><code>pub(crate)</code></li>
|
||
<li><code>pub(self)</code></li>
|
||
<li><code>pub(super)</code></li>
|
||
<li><code>pub(in some::path)</code></li>
|
||
</ul>
|
||
<p>To handle the case of visibilities inside of tuple structs, the parser
|
||
needs to distinguish parentheses that specify visibility restrictions
|
||
from parentheses that form part of a tuple type.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">struct</span> <span class="ident">S</span>(<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">A</span>, <span class="kw">pub</span> (<span class="ident">B</span>, <span class="ident">C</span>));</code></pre></div>
|
||
<p>In this example input the first tuple struct element of <code>S</code> has
|
||
<code>pub(crate)</code> visibility while the second tuple struct element has <code>pub</code>
|
||
visibility; the parentheses around <code>(B, C)</code> are part of the type rather
|
||
than part of a visibility restriction.</p>
|
||
<p>The parser uses a forked parse stream to check the first token inside of
|
||
parentheses after the <code>pub</code> keyword. This is a small bounded amount of
|
||
work performed against the forked parse stream.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">syn</span>::{<span class="ident">parenthesized</span>, <span class="ident">token</span>, <span class="ident">Ident</span>, <span class="ident">Path</span>, <span class="prelude-ty">Result</span>, <span class="ident">Token</span>};
|
||
<span class="kw">use</span> <span class="ident">syn::ext::IdentExt</span>;
|
||
<span class="kw">use</span> <span class="ident">syn::parse</span>::{<span class="ident">Parse</span>, <span class="ident">ParseStream</span>};
|
||
|
||
<span class="kw">struct</span> <span class="ident">PubVisibility</span> {
|
||
<span class="ident">pub_token</span>: <span class="macro">Token!</span>[<span class="kw">pub</span>],
|
||
<span class="ident">restricted</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Restricted</span><span class="op">></span>,
|
||
}
|
||
|
||
<span class="kw">struct</span> <span class="ident">Restricted</span> {
|
||
<span class="ident">paren_token</span>: <span class="ident">token::Paren</span>,
|
||
<span class="ident">in_token</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="macro">Token!</span>[<span class="kw">in</span>]<span class="op">></span>,
|
||
<span class="ident">path</span>: <span class="ident">Path</span>,
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">Parse</span> <span class="kw">for</span> <span class="ident">PubVisibility</span> {
|
||
<span class="kw">fn</span> <span class="ident">parse</span>(<span class="ident">input</span>: <span class="ident">ParseStream</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span><span class="op">></span> {
|
||
<span class="kw">let</span> <span class="ident">pub_token</span>: <span class="macro">Token!</span>[<span class="kw">pub</span>] <span class="op">=</span> <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>;
|
||
|
||
<span class="kw">if</span> <span class="ident">input</span>.<span class="ident">peek</span>(<span class="ident">token::Paren</span>) {
|
||
<span class="kw">let</span> <span class="ident">ahead</span> <span class="op">=</span> <span class="ident">input</span>.<span class="ident">fork</span>();
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">content</span>;
|
||
<span class="macro">parenthesized!</span>(<span class="ident">content</span> <span class="kw">in</span> <span class="ident">ahead</span>);
|
||
|
||
<span class="kw">if</span> <span class="ident">content</span>.<span class="ident">peek</span>(<span class="macro">Token!</span>[<span class="kw">crate</span>])
|
||
<span class="op">|</span><span class="op">|</span> <span class="ident">content</span>.<span class="ident">peek</span>(<span class="macro">Token!</span>[<span class="self">self</span>])
|
||
<span class="op">|</span><span class="op">|</span> <span class="ident">content</span>.<span class="ident">peek</span>(<span class="macro">Token!</span>[<span class="kw">super</span>])
|
||
{
|
||
<span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">PubVisibility</span> {
|
||
<span class="ident">pub_token</span>,
|
||
<span class="ident">restricted</span>: <span class="prelude-val">Some</span>(<span class="ident">Restricted</span> {
|
||
<span class="ident">paren_token</span>: <span class="macro">parenthesized!</span>(<span class="ident">content</span> <span class="kw">in</span> <span class="ident">input</span>),
|
||
<span class="ident">in_token</span>: <span class="prelude-val">None</span>,
|
||
<span class="ident">path</span>: <span class="ident">Path::from</span>(<span class="ident">content</span>.<span class="ident">call</span>(<span class="ident">Ident::parse_any</span>)<span class="question-mark">?</span>),
|
||
}),
|
||
});
|
||
} <span class="kw">else</span> <span class="kw">if</span> <span class="ident">content</span>.<span class="ident">peek</span>(<span class="macro">Token!</span>[<span class="kw">in</span>]) {
|
||
<span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">PubVisibility</span> {
|
||
<span class="ident">pub_token</span>,
|
||
<span class="ident">restricted</span>: <span class="prelude-val">Some</span>(<span class="ident">Restricted</span> {
|
||
<span class="ident">paren_token</span>: <span class="macro">parenthesized!</span>(<span class="ident">content</span> <span class="kw">in</span> <span class="ident">input</span>),
|
||
<span class="ident">in_token</span>: <span class="prelude-val">Some</span>(<span class="ident">content</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>),
|
||
<span class="ident">path</span>: <span class="ident">content</span>.<span class="ident">call</span>(<span class="ident">Path::parse_mod_style</span>)<span class="question-mark">?</span>,
|
||
}),
|
||
});
|
||
}
|
||
}
|
||
|
||
<span class="prelude-val">Ok</span>(<span class="ident">PubVisibility</span> {
|
||
<span class="ident">pub_token</span>,
|
||
<span class="ident">restricted</span>: <span class="prelude-val">None</span>,
|
||
})
|
||
}
|
||
}</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.error" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#957-959">source</a></span><h4 class="code-header">pub fn <a href="#method.error" class="fnname">error</a><T: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a>>(&self, message: T) -> <a class="struct" href="struct.Error.html" title="struct syn::parse::Error">Error</a></h4></section></summary><div class="docblock"><p>Triggers an error at the current position of the parse stream.</p>
|
||
<h5 id="example-7"><a href="#example-7">Example</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">syn</span>::{<span class="ident">Expr</span>, <span class="prelude-ty">Result</span>, <span class="ident">Token</span>};
|
||
<span class="kw">use</span> <span class="ident">syn::parse</span>::{<span class="ident">Parse</span>, <span class="ident">ParseStream</span>};
|
||
|
||
<span class="comment">// Some kind of loop: `while` or `for` or `loop`.</span>
|
||
<span class="kw">struct</span> <span class="ident">Loop</span> {
|
||
<span class="ident">expr</span>: <span class="ident">Expr</span>,
|
||
}
|
||
|
||
<span class="kw">impl</span> <span class="ident">Parse</span> <span class="kw">for</span> <span class="ident">Loop</span> {
|
||
<span class="kw">fn</span> <span class="ident">parse</span>(<span class="ident">input</span>: <span class="ident">ParseStream</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span><span class="op">></span> {
|
||
<span class="kw">if</span> <span class="ident">input</span>.<span class="ident">peek</span>(<span class="macro">Token!</span>[<span class="kw">while</span>])
|
||
<span class="op">|</span><span class="op">|</span> <span class="ident">input</span>.<span class="ident">peek</span>(<span class="macro">Token!</span>[<span class="kw">for</span>])
|
||
<span class="op">|</span><span class="op">|</span> <span class="ident">input</span>.<span class="ident">peek</span>(<span class="macro">Token!</span>[<span class="kw">loop</span>])
|
||
{
|
||
<span class="prelude-val">Ok</span>(<span class="ident">Loop</span> {
|
||
<span class="ident">expr</span>: <span class="ident">input</span>.<span class="ident">parse</span>()<span class="question-mark">?</span>,
|
||
})
|
||
} <span class="kw">else</span> {
|
||
<span class="prelude-val">Err</span>(<span class="ident">input</span>.<span class="ident">error</span>(<span class="string">"expected some kind of loop"</span>))
|
||
}
|
||
}
|
||
}</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.step" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#1006-1034">source</a></span><h4 class="code-header">pub fn <a href="#method.step" class="fnname">step</a><F, R>(&self, function: F) -> <a class="type" href="type.Result.html" title="type syn::parse::Result">Result</a><R> <span class="where fmt-newline">where<br> F: for<'c> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="struct" href="struct.StepCursor.html" title="struct syn::parse::StepCursor">StepCursor</a><'c, 'a>) -> <a class="type" href="type.Result.html" title="type syn::parse::Result">Result</a><(R, <a class="struct" href="../buffer/struct.Cursor.html" title="struct syn::buffer::Cursor">Cursor</a><'c>)>, </span></h4></section></summary><div class="docblock"><p>Speculatively parses tokens from this parse stream, advancing the
|
||
position of this stream only if parsing succeeds.</p>
|
||
<p>This is a powerful low-level API used for defining the <code>Parse</code> impls of
|
||
the basic built-in token types. It is not something that will be used
|
||
widely outside of the Syn codebase.</p>
|
||
<h5 id="example-8"><a href="#example-8">Example</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">proc_macro2::TokenTree</span>;
|
||
<span class="kw">use</span> <span class="ident">syn::Result</span>;
|
||
<span class="kw">use</span> <span class="ident">syn::parse::ParseStream</span>;
|
||
|
||
<span class="comment">// This function advances the stream past the next occurrence of `@`. If</span>
|
||
<span class="comment">// no `@` is present in the stream, the stream position is unchanged and</span>
|
||
<span class="comment">// an error is returned.</span>
|
||
<span class="kw">fn</span> <span class="ident">skip_past_next_at</span>(<span class="ident">input</span>: <span class="ident">ParseStream</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span>()<span class="op">></span> {
|
||
<span class="ident">input</span>.<span class="ident">step</span>(<span class="op">|</span><span class="ident">cursor</span><span class="op">|</span> {
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">rest</span> <span class="op">=</span> <span class="kw-2">*</span><span class="ident">cursor</span>;
|
||
<span class="kw">while</span> <span class="kw">let</span> <span class="prelude-val">Some</span>((<span class="ident">tt</span>, <span class="ident">next</span>)) <span class="op">=</span> <span class="ident">rest</span>.<span class="ident">token_tree</span>() {
|
||
<span class="kw">match</span> <span class="kw-2">&</span><span class="ident">tt</span> {
|
||
<span class="ident">TokenTree::Punct</span>(<span class="ident">punct</span>) <span class="kw">if</span> <span class="ident">punct</span>.<span class="ident">as_char</span>() <span class="op">==</span> <span class="string">'@'</span> => {
|
||
<span class="kw">return</span> <span class="prelude-val">Ok</span>(((), <span class="ident">next</span>));
|
||
}
|
||
<span class="kw">_</span> => <span class="ident">rest</span> <span class="op">=</span> <span class="ident">next</span>,
|
||
}
|
||
}
|
||
<span class="prelude-val">Err</span>(<span class="ident">cursor</span>.<span class="ident">error</span>(<span class="string">"no `@` was found after this point"</span>))
|
||
})
|
||
}</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.span" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#1039-1046">source</a></span><h4 class="code-header">pub fn <a href="#method.span" class="fnname">span</a>(&self) -> <a class="struct" href="../../proc_macro2/struct.Span.html" title="struct proc_macro2::Span">Span</a></h4></section></summary><div class="docblock"><p>Returns the <code>Span</code> of the next token in the parse stream, or
|
||
<code>Span::call_site()</code> if this parse stream has completely exhausted its
|
||
input <code>TokenStream</code>.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.cursor" class="method has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#1053-1055">source</a></span><h4 class="code-header">pub fn <a href="#method.cursor" class="fnname">cursor</a>(&self) -> <a class="struct" href="../buffer/struct.Cursor.html" title="struct syn::buffer::Cursor">Cursor</a><'a></h4></section></summary><div class="docblock"><p>Provides low-level access to the token representation underlying this
|
||
parse stream.</p>
|
||
<p>Cursors are immutable so no operations you perform against the cursor
|
||
will affect the state of this parse stream.</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-ParseBuffer%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#287-291">source</a></span><a href="#impl-Debug-for-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.ParseBuffer.html" title="struct syn::parse::ParseBuffer">ParseBuffer</a><'a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt-1" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#288-290">source</a></span><a href="#method.fmt-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Display-for-ParseBuffer%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#281-285">source</a></span><a href="#impl-Display-for-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="struct.ParseBuffer.html" title="struct syn::parse::ParseBuffer">ParseBuffer</a><'a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#282-284">source</a></span><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Display.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Drop-for-ParseBuffer%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#270-279">source</a></span><a href="#impl-Drop-for-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="struct.ParseBuffer.html" title="struct syn::parse::ParseBuffer">ParseBuffer</a><'a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/parse.rs.html#271-278">source</a></span><a href="#method.drop" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/ops/drop/trait.Drop.html#tymethod.drop" class="fnname">drop</a>(&mut self)</h4></section></summary><div class='docblock'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/1.64.0/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Speculative-for-ParseBuffer%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/discouraged.rs.html#160-194">source</a></span><a href="#impl-Speculative-for-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="discouraged/trait.Speculative.html" title="trait syn::parse::discouraged::Speculative">Speculative</a> for <a class="struct" href="struct.ParseBuffer.html" title="struct syn::parse::ParseBuffer">ParseBuffer</a><'a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.advance_to" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/syn/discouraged.rs.html#161-193">source</a></span><a href="#method.advance_to" class="anchor"></a><h4 class="code-header">fn <a href="discouraged/trait.Speculative.html#tymethod.advance_to" class="fnname">advance_to</a>(&self, fork: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>Self)</h4></section></summary><div class='docblock'><p>Advance this parse stream to the position of a forked parse stream. <a href="discouraged/trait.Speculative.html#tymethod.advance_to">Read more</a></p>
|
||
</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-ParseBuffer%3C%27a%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> !<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.ParseBuffer.html" title="struct syn::parse::ParseBuffer">ParseBuffer</a><'a></h3></section><section id="impl-Send-for-ParseBuffer%3C%27a%3E" class="impl has-srclink"><a href="#impl-Send-for-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> !<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.ParseBuffer.html" title="struct syn::parse::ParseBuffer">ParseBuffer</a><'a></h3></section><section id="impl-Sync-for-ParseBuffer%3C%27a%3E" class="impl has-srclink"><a href="#impl-Sync-for-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> !<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.ParseBuffer.html" title="struct syn::parse::ParseBuffer">ParseBuffer</a><'a></h3></section><section id="impl-Unpin-for-ParseBuffer%3C%27a%3E" class="impl has-srclink"><a href="#impl-Unpin-for-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.ParseBuffer.html" title="struct syn::parse::ParseBuffer">ParseBuffer</a><'a></h3></section><section id="impl-UnwindSafe-for-ParseBuffer%3C%27a%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<'a> !<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.ParseBuffer.html" title="struct syn::parse::ParseBuffer">ParseBuffer</a><'a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-ParseBuffer%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/any.rs.html#203">source</a></span><a href="#impl-Any-for-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/any.rs.html#204">source</a></span><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-ParseBuffer%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#209">source</a></span><a href="#impl-Borrow%3CT%3E-for-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#211">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>T</h4></section></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-ParseBuffer%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#218">source</a></span><a href="#impl-BorrowMut%3CT%3E-for-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#219">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>T</h4></section></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-ParseBuffer%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#557">source</a></span><a href="#impl-From%3CT%3E-for-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#559">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-ParseBuffer%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#541">source</a></span><a href="#impl-Into%3CU%3E-for-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#549">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToString-for-ParseBuffer%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/string.rs.html#2479">source</a></span><a href="#impl-ToString-for-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/alloc/string/trait.ToString.html" title="trait alloc::string::ToString">ToString</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_string" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/alloc/string.rs.html#2485">source</a></span><a href="#method.to_string" class="anchor"></a><h4 class="code-header">default fn <a href="https://doc.rust-lang.org/1.64.0/alloc/string/trait.ToString.html#tymethod.to_string" class="fnname">to_string</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></section></summary><div class='docblock'><p>Converts the given value to a <code>String</code>. <a href="https://doc.rust-lang.org/1.64.0/alloc/string/trait.ToString.html#tymethod.to_string">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-ParseBuffer%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#598">source</a></span><a href="#impl-TryFrom%3CU%3E-for-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#604">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-ParseBuffer%3C%27a%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#583">source</a></span><a href="#impl-TryInto%3CU%3E-for-ParseBuffer%3C%27a%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#589">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="syn" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |