<!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 `IResult` enum in crate `syn`."> <meta name="keywords" content="rust, rustlang, rust-lang, IResult"> <title>syn::parse::IResult - Rust</title> <link rel="stylesheet" type="text/css" href="../../normalize.css"> <link rel="stylesheet" type="text/css" href="../../rustdoc.css"> <link rel="stylesheet" type="text/css" href="../../main.css"> </head> <body class="rustdoc enum"> <!--[if lte IE 8]> <div class="warning"> This old browser is unsupported and will most likely display funky things. </div> <![endif]--> <nav class="sidebar"> <p class='location'>Enum IResult</p><div class="block items"><ul><li><a href="#variants">Variants</a></li><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='../index.html'>syn</a>::<wbr><a href='index.html'>parse</a></p><script>window.sidebarCurrent = {name: 'IResult', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script> </nav> <nav class="sub"> <form class="search-form js-only"> <div class="search-container"> <input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"> </div> </form> </nav> <section id='main' class="content"> <h1 class='fqn'><span class='in-band'>Enum <a href='../index.html'>syn</a>::<wbr><a href='index.html'>parse</a>::<wbr><a class="enum" href=''>IResult</a></span><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/synom/lib.rs.html#34-40' title='goto source code'>[src]</a></span></h1> <pre class='rust enum'>pub enum IResult<I, O> { Done(I, O), Error, }</pre><div class='docblock'><p>The result of a parser.</p> </div><h2 id='variants' class='variants'>Variants</h2> <span id='variant.Done' class='variant'><span id='Done.v' class='invisible'><code>Done(I, O)</code></span></span><div class='docblock'><p>Parsing succeeded. The first field contains the rest of the unparsed data and the second field contains the parse result.</p> </div><span id='variant.Error' class='variant'><span id='Error.v' class='invisible'><code>Error</code></span></span><div class='docblock'><p>Parsing failed.</p> </div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl<'a, O> <a class="enum" href="../../syn/parse/enum.IResult.html" title="enum syn::parse::IResult">IResult</a><&'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, O></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/synom/lib.rs.html#42-80' title='goto source code'>[src]</a></span></h3> <div class='impl-items'><h4 id='method.expect' class="method"><span id='expect.v' class='invisible'><code>fn <a href='#method.expect' class='fnname'>expect</a>(self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> O</code></span></h4> <div class='docblock'><p>Unwraps the result, asserting the the parse is complete. Panics with a message based on the given string if the parse failed or is incomplete.</p> <pre class="rust rust-example-rendered"> <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">syn</span>; <span class="attribute">#[<span class="ident">macro_use</span>]</span> <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">synom</span>; <span class="kw">use</span> <span class="ident">syn</span>::<span class="ident">Ty</span>; <span class="kw">use</span> <span class="ident">syn</span>::<span class="ident">parse</span>::<span class="ident">ty</span>; <span class="comment">// One or more Rust types separated by commas.</span> <span class="macro">named</span><span class="macro">!</span>(<span class="ident">comma_separated_types</span> <span class="op">-></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">Ty</span><span class="op">></span>, <span class="macro">separated_nonempty_list</span><span class="macro">!</span>(<span class="macro">punct</span><span class="macro">!</span>(<span class="string">","</span>), <span class="ident">ty</span>) ); <span class="kw">fn</span> <span class="ident">main</span>() { <span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"&str, Map<K, V>, String"</span>; <span class="kw">let</span> <span class="ident">parsed</span> <span class="op">=</span> <span class="ident">comma_separated_types</span>(<span class="ident">input</span>).<span class="ident">expect</span>(<span class="string">"comma-separated types"</span>); <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">parsed</span>.<span class="ident">len</span>(), <span class="number">3</span>); <span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:?}"</span>, <span class="ident">parsed</span>); }</pre> </div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl<I, O> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../../syn/parse/enum.IResult.html" title="enum syn::parse::IResult">IResult</a><I, O> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,<br> O: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/synom/lib.rs.html#33' title='goto source code'>[src]</a></span></h3> <div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></code></span></h4> <div class='docblock'><p>Formats the value using the given formatter.</p> </div></div><h3 class='impl'><span class='in-band'><code>impl<I, O> <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="../../syn/parse/enum.IResult.html" title="enum syn::parse::IResult">IResult</a><I, O> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> O: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/synom/lib.rs.html#33' title='goto source code'>[src]</a></span></h3> <div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="enum" href="../../syn/parse/enum.IResult.html" title="enum syn::parse::IResult">IResult</a><I, O></code></span></h4> <div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p> </div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: &Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4> <div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p> </div></div><h3 class='impl'><span class='in-band'><code>impl<I, O> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="enum" href="../../syn/parse/enum.IResult.html" title="enum syn::parse::IResult">IResult</a><I, O> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>,<br> O: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/synom/lib.rs.html#33' title='goto source code'>[src]</a></span></h3> <div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl<I, O> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="enum" href="../../syn/parse/enum.IResult.html" title="enum syn::parse::IResult">IResult</a><I, O>> for <a class="enum" href="../../syn/parse/enum.IResult.html" title="enum syn::parse::IResult">IResult</a><I, O> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><I>,<br> O: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><O>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/synom/lib.rs.html#33' title='goto source code'>[src]</a></span></h3> <div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, __arg_0: &<a class="enum" href="../../syn/parse/enum.IResult.html" title="enum syn::parse::IResult">IResult</a><I, O>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4> <div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p> </div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, __arg_0: &<a class="enum" href="../../syn/parse/enum.IResult.html" title="enum syn::parse::IResult">IResult</a><I, O>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4> <div class='docblock'><p>This method tests for <code>!=</code>.</p> </div></div></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>?</dt> <dd>Show this help dialog</dd> <dt>S</dt> <dd>Focus the search field</dd> <dt>⇤</dt> <dd>Move up in search results</dd> <dt>⇥</dt> <dd>Move down in search results</dd> <dt>⏎</dt> <dd>Go to active search result</dd> <dt>+</dt> <dd>Collapse/expand 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> </div> </div> </aside> <script> window.rootPath = "../../"; window.currentCrate = "syn"; </script> <script src="../../main.js"></script> <script defer src="../../search-index.js"></script> </body> </html>