|
|
<!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 `Speculative` trait in crate `syn`."><meta name="keywords" content="rust, rustlang, rust-lang, Speculative"><title>syn::parse::discouraged::Speculative - 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 Speculative</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.advance_to">advance_to</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>::<wbr><a href='index.html'>discouraged</a></p><script>window.sidebarCurrent = {name: 'Speculative', 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/discouraged.rs.html#6-159' 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 href='index.html'>discouraged</a>::<wbr><a class="trait" href=''>Speculative</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Speculative {
|
|
|
fn <a href='#tymethod.advance_to' class='fnname'>advance_to</a>(&self, fork: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self);
|
|
|
}</pre></div><div class='docblock'><p>Extensions to the <code>ParseStream</code> API to support speculative parsing.</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.advance_to' class='method'><code id='advance_to.v'>fn <a href='#tymethod.advance_to' class='fnname'>advance_to</a>(&self, fork: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></h3><div class='docblock'><p>Advance this parse stream to the position of a forked parse stream.</p>
|
|
|
<p>This is the opposite operation to <a href="../struct.ParseBuffer.html#method.fork"><code>ParseStream::fork</code></a>. You can fork a
|
|
|
parse stream, perform some speculative parsing, then join the original
|
|
|
stream to the fork to "commit" the parsing from the fork to the main
|
|
|
stream.</p>
|
|
|
<p>If you can avoid doing this, you should, as it limits the ability to
|
|
|
generate useful errors. That said, it is often the only way to parse
|
|
|
syntax of the form <code>A* B*</code> for arbitrary syntax <code>A</code> and <code>B</code>. The problem
|
|
|
is that when the fork fails to parse an <code>A</code>, it's impossible to tell
|
|
|
whether that was because of a syntax error and the user meant to provide
|
|
|
an <code>A</code>, or that the <code>A</code>s are finished and its time to start parsing
|
|
|
<code>B</code>s. Use with care.</p>
|
|
|
<p>Also note that if <code>A</code> is a subset of <code>B</code>, <code>A* B*</code> can be parsed by
|
|
|
parsing <code>B*</code> and removing the leading members of <code>A</code> from the
|
|
|
repetition, bypassing the need to involve the downsides associated with
|
|
|
speculative parsing.</p>
|
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|
|
<p>There has been chatter about the possibility of making the colons in the
|
|
|
turbofish syntax like <code>path::to::<T></code> no longer required by accepting
|
|
|
<code>path::to<T></code> in expression position. Specifically, according to <a href="https://github.com/rust-lang/rfcs/pull/2544">RFC
|
|
|
2544</a>, <a href="../../struct.PathSegment.html"><code>PathSegment</code></a> parsing should always try to consume a following
|
|
|
<code><</code> token as the start of generic arguments, and reset to the <code><</code> if
|
|
|
that fails (e.g. the token is acting as a less-than operator).</p>
|
|
|
<p>This is the exact kind of parsing behavior which requires the "fork,
|
|
|
try, commit" behavior that <a href="../struct.ParseBuffer.html#method.fork"><code>ParseStream::fork</code></a> discourages. With
|
|
|
<code>advance_to</code>, we can avoid having to parse the speculatively parsed
|
|
|
content a second time.</p>
|
|
|
<p>This change in behavior can be implemented in syn by replacing just the
|
|
|
<code>Parse</code> implementation for <code>PathSegment</code>:</p>
|
|
|
<pre><code class="language-edition2018"># use syn::ext::IdentExt;
|
|
|
use syn::parse::discouraged::Speculative;
|
|
|
# use syn::parse::{Parse, ParseStream};
|
|
|
# use syn::{Ident, PathArguments, Result, Token};
|
|
|
|
|
|
pub struct PathSegment {
|
|
|
pub ident: Ident,
|
|
|
pub arguments: PathArguments,
|
|
|
}
|
|
|
#
|
|
|
# impl<T> From<T> for PathSegment
|
|
|
# where
|
|
|
# T: Into<Ident>,
|
|
|
# {
|
|
|
# fn from(ident: T) -> Self {
|
|
|
# PathSegment {
|
|
|
# ident: ident.into(),
|
|
|
# arguments: PathArguments::None,
|
|
|
# }
|
|
|
# }
|
|
|
# }
|
|
|
|
|
|
impl Parse for PathSegment {
|
|
|
fn parse(input: ParseStream) -> Result<Self> {
|
|
|
if input.peek(Token![super])
|
|
|
|| input.peek(Token![self])
|
|
|
|| input.peek(Token![Self])
|
|
|
|| input.peek(Token![crate])
|
|
|
|| input.peek(Token![extern])
|
|
|
{
|
|
|
let ident = input.call(Ident::parse_any)?;
|
|
|
return Ok(PathSegment::from(ident));
|
|
|
}
|
|
|
|
|
|
let ident = input.parse()?;
|
|
|
if input.peek(Token![::]) && input.peek3(Token![<]) {
|
|
|
return Ok(PathSegment {
|
|
|
ident: ident,
|
|
|
arguments: PathArguments::AngleBracketed(input.parse()?),
|
|
|
});
|
|
|
}
|
|
|
if input.peek(Token![<]) && !input.peek(Token![<=]) {
|
|
|
let fork = input.fork();
|
|
|
if let Ok(arguments) = fork.parse() {
|
|
|
input.advance_to(&fork);
|
|
|
return Ok(PathSegment {
|
|
|
ident: ident,
|
|
|
arguments: PathArguments::AngleBracketed(arguments),
|
|
|
});
|
|
|
}
|
|
|
}
|
|
|
Ok(PathSegment::from(ident))
|
|
|
}
|
|
|
}
|
|
|
|
|
|
# syn::parse_str::<PathSegment>("a<b,c>").unwrap();
|
|
|
</code></pre>
|
|
|
<h1 id="drawbacks" class="section-header"><a href="#drawbacks">Drawbacks</a></h1>
|
|
|
<p>The main drawback of this style of speculative parsing is in error
|
|
|
presentation. Even if the lookahead is the "correct" parse, the error
|
|
|
that is shown is that of the "fallback" parse. To use the same example
|
|
|
as the turbofish above, take the following unfinished "turbofish":</p>
|
|
|
<pre><code class="language-text">let _ = f<&'a fn(), for<'a> serde::>();
|
|
|
</code></pre>
|
|
|
<p>If this is parsed as generic arguments, we can provide the error message</p>
|
|
|
<pre><code class="language-text">error: expected identifier
|
|
|
--> src.rs:L:C
|
|
|
|
|
|
|
L | let _ = f<&'a fn(), for<'a> serde::>();
|
|
|
| ^
|
|
|
</code></pre>
|
|
|
<p>but if parsed using the above speculative parsing, it falls back to
|
|
|
assuming that the <code><</code> is a less-than when it fails to parse the generic
|
|
|
arguments, and tries to interpret the <code>&'a</code> as the start of a labelled
|
|
|
loop, resulting in the much less helpful error</p>
|
|
|
<pre><code class="language-text">error: expected `:`
|
|
|
--> src.rs:L:C
|
|
|
|
|
|
|
L | let _ = f<&'a fn(), for<'a> serde::>();
|
|
|
| ^^
|
|
|
</code></pre>
|
|
|
<p>This can be mitigated with various heuristics (two examples: show both
|
|
|
forks' parse errors, or show the one that consumed more tokens), but
|
|
|
when you can control the grammar, sticking to something that can be
|
|
|
parsed LL(3) and without the LL(*) speculative parsing this makes
|
|
|
possible, displaying reasonable errors becomes much more simple.</p>
|
|
|
<h1 id="performance" class="section-header"><a href="#performance">Performance</a></h1>
|
|
|
<p>This method performs a cheap fixed amount of work that does not depend
|
|
|
on how far apart the two streams are positioned.</p>
|
|
|
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
|
|
<p>The forked stream in the argument of <code>advance_to</code> must have been
|
|
|
obtained by forking <code>self</code>. Attempting to advance to any other stream
|
|
|
will cause a panic.</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-Speculative' class='impl'><code class='in-band'>impl<'a> Speculative for <a class="struct" href="../../../syn/parse/struct.ParseBuffer.html" title="struct syn::parse::ParseBuffer">ParseBuffer</a><'a></code><a href='#impl-Speculative' class='anchor'></a><a class='srclink' href='../../../src/syn/discouraged.rs.html#161-171' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.advance_to' class="method hidden"><code id='advance_to.v-1'>fn <a href='#method.advance_to' class='fnname'>advance_to</a>(&self, fork: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><a class='srclink' href='../../../src/syn/discouraged.rs.html#162-170' 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/discouraged/trait.Speculative.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> |
