edlang/winnow/combinator/trait.Alt.html

8 lines
70 KiB
HTML
Raw Normal View History

<!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="Helper trait for the alt() combinator."><title>Alt in winnow::combinator - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2">`)</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-e935ef01ae1c1829.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="winnow" data-themes="" data-resource-suffix="" data-rustdoc-version="1.78.0 (9b00956e5 2024-04-29)" data-channel="1.78.0" data-search-js="search-42d8da7a6b9792c2.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc trait"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../winnow/index.html">winnow</a><span class="version">0.6.7</span></h2></div><h2 class="location"><a href="#">Alt</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.choice">choice</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Alt%3CI,+O,+E%3E-for-(A,)">(A,)</a></li><li><a href="#impl-Alt%3CI,+Output,+Error%3E-for-(Alt2,+Alt3)">(Alt2, Alt3)</a></li><li><a href="#impl-Alt%3CI,+Output,+Error%3E-for-(Alt2,+Alt3,+Alt4)">(Alt2, Alt3, Alt4)</a></li><li><a href="#impl-Alt%3CI,+Output,+Error%3E-for-(Alt2,+Alt3,+Alt4,+Alt5)">(Alt2, Alt3, Alt4, Alt5)</a></li><li><a href="#impl-Alt%3CI,+Output,+Error%3E-for-(Alt2,+Alt3,+Alt4,+Alt5,+Alt6)">(Alt2, Alt3, Alt4, Alt5, Alt6)</a></li><li><a href="#impl-Alt%3CI,+Output,+Error%3E-for-(Alt2,+Alt3,+Alt4,+Alt5,+Alt6,+Alt7)">(Alt2, Alt3, Alt4, Alt5, Alt6, Alt7)</a></li><li><a href="#impl-Alt%3CI,+Output,+Error%3E-for-(Alt2,+Alt3,+Alt4,+Alt5,+Alt6,+Alt7,+Alt8)">(Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8)</a></li><li><a href="#impl-Alt%3CI,+Output,+Error%3E-for-(Alt2,+Alt3,+Alt4,+Alt5,+Alt6,+Alt7,+Alt8,+Alt9)">(Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9)</a></li><li><a href="#impl-Alt%3CI,+Output,+Error%3E-for-(Alt2,+Alt3,+Alt4,+Alt5,+Alt6,+Alt7,+Alt8,+Alt9,+Alt10)">(Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10)</a></li><li><a href="#impl-Alt%3CI,+Output,+Error%3E-for-(Alt2,+Alt3,+Alt4,+Alt5,+Alt6,+Alt7,+Alt8,+Alt9,+Alt10,+Alt11)">(Alt2, Alt3, Alt4, Alt5, Alt6, Alt7, Alt8, Alt9, Alt10, Alt11)</a></li><li><a href="#impl-Alt%3CI,+Output,+
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../winnow/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../index.html">winnow</a>::<wbr><a href="index.html">combinator</a>::<wbr><a class="trait" href="#">Alt</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/winnow/combinator/branch.rs.html#12-15">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Alt&lt;I, O, E&gt; {
// Required method
fn <a href="#tymethod.choice" class="fn">choice</a>(&amp;mut self, input: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.reference.html">&amp;mut I</a>) -&gt; <a class="type" href="../error/type.PResult.html" title="type winnow::error::PResult">PResult</a>&lt;O, E&gt;;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Helper trait for the <a href="fn.alt.html" title="fn winnow::combinator::alt">alt()</a> combinator.</p>
<p>This trait is implemented for tuples of up to 21 elements</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.choice" class="method"><a class="src rightside" href="../../src/winnow/combinator/branch.rs.html#14">source</a><h4 class="code-header">fn <a href="#tymethod.choice" class="fn">choice</a>(&amp;mut self, input: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.reference.html">&amp;mut I</a>) -&gt; <a class="type" href="../error/type.PResult.html" title="type winnow::error::PResult">PResult</a>&lt;O, E&gt;</h4></section></summary><div class="docblock"><p>Tests each parser in the tuple and returns the result of the first one that succeeds</p>
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-Alt%3CI,+O,+E%3E-for-(A,)" class="impl"><a class="src rightside" href="../../src/winnow/combinator/branch.rs.html#228-232">source</a><a href="#impl-Alt%3CI,+O,+E%3E-for-(A,)" class="anchor">§</a><h3 class="code-header">impl&lt;I: <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>, O, E: <a class="trait" href="../error/trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a>&lt;I&gt;, A: <a class="trait" href="../trait.Parser.html" title="trait winnow::Parser">Parser</a>&lt;I, O, E&gt;&gt; <a class="trait" href="trait.Alt.html" title="trait winnow::combinator::Alt">Alt</a>&lt;I, O, E&gt; for <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.tuple.html">(A,)</a></h3></section></summary><div class="impl-items"><section id="method.choice" class="method trait-impl"><a class="src rightside" href="../../src/winnow/combinator/branch.rs.html#229-231">source</a><a href="#method.choice" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.choice" class="fn">choice</a>(&amp;mut self, input: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.reference.html">&amp;mut I</a>) -&gt; <a class="type" href="../error/type.PResult.html" title="type winnow::error::PResult">PResult</a>&lt;O, E&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Alt%3CI,+Output,+Error%3E-for-(Alt2,+Alt3)" class="impl"><a class="src rightside" href="../../src/winnow/combinator/branch.rs.html#225">source</a><a href="#impl-Alt%3CI,+Output,+Error%3E-for-(Alt2,+Alt3)" class="anchor">§</a><h3 class="code-header">impl&lt;I: <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>, Output, Error: <a class="trait" href="../error/trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a>&lt;I&gt;, Alt2: <a class="trait" href="../trait.Parser.html" title="trait winnow::Parser">Parser</a>&lt;I, Output, Error&gt;, Alt3: <a class="trait" href="../trait.Parser.html" title="trait winnow::Parser">Parser</a>&lt;I, Output, Error&gt;&gt; <a class="trait" href="trait.Alt.html" title="trait winnow::combinator::Alt">Alt</a>&lt;I, Output, Error&gt; for <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.tuple.html">(Alt2, Alt3)</a></h3></section></summary><div class="impl-items"><section id="method.choice-1" class="method trait-impl"><a class="src rightside" href="../../src/winnow/combinator/branch.rs.html#225">source</a><a href="#method.choice-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.choice" class="fn">choice</a>(&amp;mut self, input: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.reference.html">&amp;mut I</a>) -&gt; <a class="type" href="../error/type.PResult.html" title="type winnow::error::PResult">PResult</a>&lt;Output, Error&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Alt%3CI,+Output,+Error%3E-for-(Alt2,+Alt3,+Alt4)" class="impl"><a class="src rightside" href="../../src/winnow/combinator/branch.rs.html#225">source</a><a href="#impl-Alt%3CI,+Output,+Error%3E-for-(Alt2,+Alt3,+Alt4)" class="anchor">§</a><h3 class="code-header">impl&lt;I: <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>, Output, Error: <a class="trait" href="../error/trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a>&lt;I&gt;, Alt2: <a class="trait" href="../trait.Parser.html" title="trait winnow::Parser">Parser</a>&lt;I, Output, Error&gt;, Alt3: <a class="trait" href="../trait.Parser.html" title="trait winnow::Parser">Parser</a>&lt;I, Output, Error&gt;, Alt4: <a class="trait" href="../trait.Parser.html" title="trait winnow::Parser