<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../../winnow/all.html"title="show sidebar"></a></div><inputclass="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"><divid="help-button"tabindex="-1"><ahref="../../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Module <ahref="../index.html">winnow</a>::<wbr><aclass="mod"href="#">error</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../../src/winnow/error.rs.html#1-1410">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><h2id="error-management"><aclass="doc-anchor"href="#error-management">§</a>Error management</h2>
<p>Errors are designed with multiple needs in mind:</p>
<ul>
<li>Accumulate more <ahref="../trait.Parser.html#method.context"title="method winnow::Parser::context">context</a> as the error goes up the parser chain</li>
<li>Distinguish between <ahref="enum.ErrMode.html"title="enum winnow::error::ErrMode">recoverable errors,
unrecoverable errors, and more data is needed</a></li>
<li>Have a very low overhead, as errors are often discarded by the calling parser (examples: <code>repeat</code>, <code>alt</code>)</li>
<li>Can be modified according to the user’s needs, because some languages need a lot more information</li>
<li>Help thread-through the <ahref="../stream/index.html"title="mod winnow::stream">stream</a></li>
</ul>
<p>To abstract these needs away from the user, generally <code>winnow</code> parsers use the <ahref="type.PResult.html"title="type winnow::error::PResult"><code>PResult</code></a>
alias, rather than <ahref="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result"><code>Result</code></a>. <ahref="../trait.Parser.html#method.parse"title="method winnow::Parser::parse"><code>Parser::parse</code></a> is a top-level operation
</div></details><h2id="structs"class="section-header">Structs<ahref="#structs"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="struct"href="struct.ContextError.html"title="struct winnow::error::ContextError">ContextError</a></div><divclass="desc docblock-short">Accumulate context while backtracking errors</div></li><li><divclass="item-name"><aclass="struct"href="struct.InputError.html"title="struct winnow::error::InputError">InputError</a></div><divclass="desc docblock-short">Capture input on error</div></li><li><divclass="item-name"><aclass="struct"href="struct.ParseError.html"title="struct winnow::error::ParseError">ParseError</a></div><divclass="desc docblock-short">See <ahref="../trait.Parser.html#method.parse"title="method winnow::Parser::parse"><code>Parser::parse</code></a></div></li><li><divclass="item-name"><aclass="struct"href="struct.TreeErrorBase.html"title="struct winnow::error::TreeErrorBase">TreeErrorBase</a></div><divclass="desc docblock-short">See <ahref="enum.TreeErrorFrame.html#variant.Kind"title="variant winnow::error::TreeErrorFrame::Kind"><code>TreeErrorFrame::Kind</code></a>, <ahref="trait.ParserError.html#tymethod.append"title="method winnow::error::ParserError::append"><code>ParserError::append</code></a></div></li><li><divclass="item-name"><aclass="struct"href="struct.TreeErrorContext.html"title="struct winnow::error::TreeErrorContext">TreeErrorContext</a></div><divclass="desc docblock-short">See <ahref="enum.TreeErrorFrame.html#variant.Context"title="variant winnow::error::TreeErrorFrame::Context"><code>TreeErrorFrame::Context</code></a>, <ahref="trait.AddContext.html#method.add_context"title="method winnow::error::AddContext::add_context"><code>AddContext::add_context</code></a></div></li></ul><h2id="enums"class="section-header">Enums<ahref="#enums"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="enum"href="enum.ErrMode.html"title="enum winnow::error::ErrMode">ErrMode</a></div><divclass="desc docblock-short">Add parse error state to <ahref="trait.ParserError.html"title="trait winnow::error::ParserError"><code>ParserError</code></a>s</div></li><li><divclass="item-name"><aclass="enum"href="enum.ErrorKind.html"title="enum winnow::error::ErrorKind">ErrorKind</a></div><divclass="desc docblock-short">Provide some minor debug context for errors</div></li><li><divclass="item-name"><aclass="enum"href="enum.Needed.html"title="enum winnow::error::Needed">Needed</a></div><divclass="desc docblock-short">Contains information on needed data if a parser returned <code>Incomplete</code></div></li><li><divclass="item-name"><aclass="enum"href="enum.StrContext.html"title="enum winnow::error::StrContext">StrContext</a></div><divclass="desc docblock-short">Additional parse context for <ahref="struct.ContextError.html"title="struct winnow::error::ContextError"><code>ContextError</code></a> added via <ahref="../trait.Parser.html#method.context"title="method winnow::Parser::context"><code>Parser::context</code></a></div></li><li><divclass="item-name"><aclass="enum"href="enum.StrContextValue.html"title="enum winnow::error::StrContextValue">StrContextValue</a></div><divclass="desc docblock-short">See <ahref="enum.StrContext.html"title="enum winnow::error::StrContext"><code>StrContext</code></a></div></li><li><divclass="item-name"><aclass="enum"href="enum.TreeError.html"title="enum winnow::error::TreeError">TreeError</a></div><divclass="desc docblock-short">Trace all error paths, particularly for tests</div></li><li><divclass="item-name"><aclass="enum"href="enum.TreeErrorFrame.html"title="enum winnow::error::TreeErrorFrame">TreeErrorFrame</a></div><divclass="desc docblock-short">See <ahref="enum.TreeError.html#variant.Stack"title="variant winnow::error::TreeError::Stack"><code>TreeError::Stack</code></a></div></li></ul><h2id="traits"class="section-header">Traits<ahref="#traits"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass=
parser.</div></li><li><divclass="item-name"><aclass="type"href="type.PResult.html"title="type winnow::error::PResult">PResult</a></div><divclass="desc docblock-short">For use with <ahref="../trait.Parser.html#tymethod.parse_next"title="method winnow::Parser::parse_next"><code>Parser::parse_next</code></a></div></li></ul></section></div></main></body></html>
