mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 08:28:24 +00:00
39 lines
16 KiB
HTML
39 lines
16 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="The basic `Parser` trait for errors"><title>ParserError in winnow::error - Rust</title><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"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../winnow/index.html">winnow</a><span class="version">0.6.5</span></h2></div><h2 class="location"><a href="#">ParserError</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.append">append</a></li><li><a href="#tymethod.from_error_kind">from_error_kind</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.assert">assert</a></li><li><a href="#method.or">or</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-ParserError%3CI%3E-for-()">()</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In winnow::error</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<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">error</a>::<wbr><a class="trait" href="#">ParserError</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/error.rs.html#270-300">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait ParserError<I: <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
// Required methods
|
||
fn <a href="#tymethod.from_error_kind" class="fn">from_error_kind</a>(input: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&I</a>, kind: <a class="enum" href="enum.ErrorKind.html" title="enum winnow::error::ErrorKind">ErrorKind</a>) -> Self;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.append" class="fn">append</a>(
|
||
self,
|
||
input: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&I</a>,
|
||
token_start: &<I as <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>>::<a class="associatedtype" href="../stream/trait.Stream.html#associatedtype.Checkpoint" title="type winnow::stream::Stream::Checkpoint">Checkpoint</a>,
|
||
kind: <a class="enum" href="enum.ErrorKind.html" title="enum winnow::error::ErrorKind">ErrorKind</a>
|
||
) -> Self;
|
||
|
||
// Provided methods
|
||
fn <a href="#method.assert" class="fn">assert</a>(input: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&I</a>, _message: &'static <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>) -> Self
|
||
<span class="where">where I: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a></span> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.or" class="fn">or</a>(self, other: Self) -> Self { ... }
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The basic <a href="../trait.Parser.html" title="trait winnow::Parser"><code>Parser</code></a> trait for errors</p>
|
||
<p>It provides methods to create an error from some combinators,
|
||
and combine existing errors in combinators like <code>alt</code>.</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.from_error_kind" class="method"><a class="src rightside" href="../../src/winnow/error.rs.html#272">source</a><h4 class="code-header">fn <a href="#tymethod.from_error_kind" class="fn">from_error_kind</a>(input: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&I</a>, kind: <a class="enum" href="enum.ErrorKind.html" title="enum winnow::error::ErrorKind">ErrorKind</a>) -> Self</h4></section></summary><div class="docblock"><p>Creates an error from the input position and an <a href="enum.ErrorKind.html" title="enum winnow::error::ErrorKind"><code>ErrorKind</code></a></p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.append" class="method"><a class="src rightside" href="../../src/winnow/error.rs.html#290">source</a><h4 class="code-header">fn <a href="#tymethod.append" class="fn">append</a>(
|
||
self,
|
||
input: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&I</a>,
|
||
token_start: &<I as <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>>::<a class="associatedtype" href="../stream/trait.Stream.html#associatedtype.Checkpoint" title="type winnow::stream::Stream::Checkpoint">Checkpoint</a>,
|
||
kind: <a class="enum" href="enum.ErrorKind.html" title="enum winnow::error::ErrorKind">ErrorKind</a>
|
||
) -> Self</h4></section></summary><div class="docblock"><p>Like <a href="trait.ParserError.html#tymethod.from_error_kind" title="associated function winnow::error::ParserError::from_error_kind"><code>ParserError::from_error_kind</code></a> but merges it with the existing error.</p>
|
||
<p>This is useful when backtracking through a parse tree, accumulating error context on the
|
||
way.</p>
|
||
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.assert" class="method"><a class="src rightside" href="../../src/winnow/error.rs.html#276-284">source</a><h4 class="code-header">fn <a href="#method.assert" class="fn">assert</a>(input: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&I</a>, _message: &'static <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.str.html">str</a>) -> Self<div class="where">where
|
||
I: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,</div></h4></section></summary><div class="docblock"><p>Process a parser assertion</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.or" class="method"><a class="src rightside" href="../../src/winnow/error.rs.html#297-299">source</a><h4 class="code-header">fn <a href="#method.or" class="fn">or</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Combines errors from two different parse branches.</p>
|
||
<p>For example, this would be used by <a href="../combinator/fn.alt.html" title="fn winnow::combinator::alt"><code>alt</code></a> to report the error from
|
||
each case.</p>
|
||
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.76.0/reference/items/traits.html#object-safety">object safe</a>.</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-ParserError%3CI%3E-for-()" class="impl"><a class="src rightside" href="../../src/winnow/error.rs.html#474-486">source</a><a href="#impl-ParserError%3CI%3E-for-()" class="anchor">§</a><h3 class="code-header">impl<I: <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>> <a class="trait" href="trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a><I> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a></h3></section></summary><div class="impl-items"><section id="method.from_error_kind" class="method trait-impl"><a class="src rightside" href="../../src/winnow/error.rs.html#476">source</a><a href="#method.from_error_kind" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.from_error_kind" class="fn">from_error_kind</a>(_: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&I</a>, _: <a class="enum" href="enum.ErrorKind.html" title="enum winnow::error::ErrorKind">ErrorKind</a>) -> Self</h4></section><section id="method.append" class="method trait-impl"><a class="src rightside" href="../../src/winnow/error.rs.html#479-485">source</a><a href="#method.append" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.append" class="fn">append</a>(
|
||
self,
|
||
_input: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&I</a>,
|
||
_token_start: &<I as <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>>::<a class="associatedtype" href="../stream/trait.Stream.html#associatedtype.Checkpoint" title="type winnow::stream::Stream::Checkpoint">Checkpoint</a>,
|
||
_kind: <a class="enum" href="enum.ErrorKind.html" title="enum winnow::error::ErrorKind">ErrorKind</a>
|
||
) -> Self</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-ParserError%3CI%3E-for-TreeError%3CI,+C%3E" class="impl"><a class="src rightside" href="../../src/winnow/error.rs.html#889-929">source</a><a href="#impl-ParserError%3CI%3E-for-TreeError%3CI,+C%3E" class="anchor">§</a><h3 class="code-header">impl<I, C> <a class="trait" href="trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a><I> for <a class="enum" href="enum.TreeError.html" title="enum winnow::error::TreeError">TreeError</a><I, C><div class="where">where
|
||
I: <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section><section id="impl-ParserError%3CI%3E-for-InputError%3CI%3E" class="impl"><a class="src rightside" href="../../src/winnow/error.rs.html#390-408">source</a><a href="#impl-ParserError%3CI%3E-for-InputError%3CI%3E" class="anchor">§</a><h3 class="code-header">impl<I: <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>> <a class="trait" href="trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a><I> for <a class="struct" href="struct.InputError.html" title="struct winnow::error::InputError">InputError</a><I></h3></section><section id="impl-ParserError%3CI%3E-for-ErrorKind" class="impl"><a class="src rightside" href="../../src/winnow/error.rs.html#1110-1125">source</a><a href="#impl-ParserError%3CI%3E-for-ErrorKind" class="anchor">§</a><h3 class="code-header">impl<I: <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>> <a class="trait" href="trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a><I> for <a class="enum" href="enum.ErrorKind.html" title="enum winnow::error::ErrorKind">ErrorKind</a></h3></section><section id="impl-ParserError%3CI%3E-for-ContextError%3CC%3E" class="impl"><a class="src rightside" href="../../src/winnow/error.rs.html#566-586">source</a><a href="#impl-ParserError%3CI%3E-for-ContextError%3CC%3E" class="anchor">§</a><h3 class="code-header">impl<I: <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>, C> <a class="trait" href="trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a><I> for <a class="struct" href="struct.ContextError.html" title="struct winnow::error::ContextError">ContextError</a><C></h3></section><section id="impl-ParserError%3CI%3E-for-ErrMode%3CE%3E" class="impl"><a class="src rightside" href="../../src/winnow/error.rs.html#181-211">source</a><a href="#impl-ParserError%3CI%3E-for-ErrMode%3CE%3E" class="anchor">§</a><h3 class="code-header">impl<I: <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>, E: <a class="trait" href="trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a><I>> <a class="trait" href="trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a><I> for <a class="enum" href="enum.ErrMode.html" title="enum winnow::error::ErrMode">ErrMode</a><E></h3></section></div><script src="../../trait.impl/winnow/error/trait.ParserError.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html> |