369 lines
102 KiB
HTML
369 lines
102 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 complete state of a `Parser`."><meta name="keywords" content="rust, rustlang, rust-lang, ParserState"><title>ParserState in pest - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" href="https://raw.githubusercontent.com/pest-parser/pest/master/pest-logo.svg"></head><body class="rustdoc struct"><!--[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><a class="sidebar-logo" href="../pest/index.html"><div class="logo-container"><img src="https://raw.githubusercontent.com/pest-parser/pest/master/pest-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../pest/index.html"><div class="logo-container">
|
||
<img src="https://raw.githubusercontent.com/pest-parser/pest/master/pest-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">ParserState</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#implementations">Methods</a></h3><ul><li><a href="#method.atomic">atomic</a></li><li><a href="#method.atomicity">atomicity</a></li><li><a href="#method.end_of_input">end_of_input</a></li><li><a href="#method.lookahead">lookahead</a></li><li><a href="#method.match_char_by">match_char_by</a></li><li><a href="#method.match_insensitive">match_insensitive</a></li><li><a href="#method.match_range">match_range</a></li><li><a href="#method.match_string">match_string</a></li><li><a href="#method.new">new</a></li><li><a href="#method.optional">optional</a></li><li><a href="#method.position">position</a></li><li><a href="#method.repeat">repeat</a></li><li><a href="#method.restore_on_err">restore_on_err</a></li><li><a href="#method.rule">rule</a></li><li><a href="#method.sequence">sequence</a></li><li><a href="#method.skip">skip</a></li><li><a href="#method.skip_until">skip_until</a></li><li><a href="#method.stack_drop">stack_drop</a></li><li><a href="#method.stack_match_peek">stack_match_peek</a></li><li><a href="#method.stack_match_peek_slice">stack_match_peek_slice</a></li><li><a href="#method.stack_match_pop">stack_match_pop</a></li><li><a href="#method.stack_peek">stack_peek</a></li><li><a href="#method.stack_pop">stack_pop</a></li><li><a href="#method.stack_push">stack_push</a></li><li><a href="#method.start_of_input">start_of_input</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#trait-implementations">Trait Implementations</a></h3><ul><li><a href="#impl-Debug-for-ParserState%3C%27i%2C%20R%3E">Debug</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul><li><a href="#impl-RefUnwindSafe-for-ParserState%3C%27i%2C%20R%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ParserState%3C%27i%2C%20R%3E">Send</a></li><li><a href="#impl-Sync-for-ParserState%3C%27i%2C%20R%3E">Sync</a></li><li><a href="#impl-Unpin-for-ParserState%3C%27i%2C%20R%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-ParserState%3C%27i%2C%20R%3E">UnwindSafe</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#blanket-implementations">Blanket Implementations</a></h3><ul><li><a href="#impl-Any-for-ParserState%3C%27i%2C%20R%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-ParserState%3C%27i%2C%20R%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-ParserState%3C%27i%2C%20R%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-ParserState%3C%27i%2C%20R%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-ParserState%3C%27i%2C%20R%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-ParserState%3C%27i%2C%20R%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-ParserState%3C%27i%2C%20R%3E">TryInto<U></a></li></ul></div></section><h2 class="location"><a href="index.html">In pest</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../pest/index.html">
|
||
<img src="https://raw.githubusercontent.com/pest-parser/pest/master/pest-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Struct <a href="index.html">pest</a>::<wbr><a class="struct" href="#">ParserState</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/pest/parser_state.rs.html#129-139">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust struct"><code>pub struct ParserState<'i, R: <a class="trait" href="trait.RuleType.html" title="trait pest::RuleType">RuleType</a>> { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The complete state of a <a href="trait.Parser.html"><code>Parser</code></a>.</p>
|
||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-ParserState%3C%27i%2C%20R%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#187-1226">source</a></span><a href="#impl-ParserState%3C%27i%2C%20R%3E" class="anchor"></a><h3 class="code-header in-band">impl<'i, R: <a class="trait" href="trait.RuleType.html" title="trait pest::RuleType">RuleType</a>> <a class="struct" href="struct.ParserState.html" title="struct pest::ParserState">ParserState</a><'i, R></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#198-210">source</a></span><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>(input: &'i <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.str.html">str</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self></h4></section></summary><div class="docblock"><p>Allocates a fresh <code>ParserState</code> object to the heap and returns the owned <code>Box</code>. This <code>Box</code>
|
||
will be passed from closure to closure based on the needs of the specified <code>Parser</code>.</p>
|
||
<h5 id="examples"><a href="#examples">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">""</span>;
|
||
<span class="kw">let</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.position" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#229-231">source</a></span><h4 class="code-header">pub fn <a href="#method.position" class="fnname">position</a>(&self) -> &<a class="struct" href="struct.Position.html" title="struct pest::Position">Position</a><'i></h4></section></summary><div class="docblock"><p>Returns a reference to the current <code>Position</code> of the <code>ParserState</code>.</p>
|
||
<h5 id="examples-1"><a href="#examples-1">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {
|
||
<span class="ident">ab</span>
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"ab"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="ident">position</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">position</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="ident">position</span>.<span class="ident">pos</span>(), <span class="number">0</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.atomicity" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#251-253">source</a></span><h4 class="code-header">pub fn <a href="#method.atomicity" class="fnname">atomicity</a>(&self) -> <a class="enum" href="enum.Atomicity.html" title="enum pest::Atomicity">Atomicity</a></h4></section></summary><div class="docblock"><p>Returns the current atomicity of the <code>ParserState</code>.</p>
|
||
<h5 id="examples-2"><a href="#examples-2">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {
|
||
<span class="ident">ab</span>
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"ab"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="ident">atomicity</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">atomicity</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="ident">atomicity</span>, <span class="ident">Atomicity::NonAtomic</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.rule" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#290-374">source</a></span><h4 class="code-header">pub fn <a href="#method.rule" class="fnname">rule</a><F>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>, rule: R, f: F) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>>, </span></h4></section></summary><div class="docblock"><p>Wrapper needed to generate tokens. This will associate the <code>R</code> type rule to the closure
|
||
meant to match the rule.</p>
|
||
<h5 id="examples-3"><a href="#examples-3">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {
|
||
<span class="ident">a</span>
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"a"</span>;
|
||
<span class="kw">let</span> <span class="ident">pairs</span>: <span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::state</span>(<span class="ident">input</span>, <span class="op">|</span><span class="ident">state</span><span class="op">|</span> {
|
||
<span class="ident">state</span>.<span class="ident">rule</span>(<span class="ident">Rule::a</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="prelude-val">Ok</span>(<span class="ident">s</span>))
|
||
}).<span class="ident">unwrap</span>().<span class="ident">collect</span>();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="ident">pairs</span>.<span class="ident">len</span>(), <span class="number">1</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.sequence" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#459-478">source</a></span><h4 class="code-header">pub fn <a href="#method.sequence" class="fnname">sequence</a><F>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>, f: F) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>>, </span></h4></section></summary><div class="docblock"><p>Starts a sequence of transformations provided by <code>f</code> from the <code>Box<ParserState></code>. Returns
|
||
the same <code>Result</code> returned by <code>f</code> in the case of an <code>Ok</code>, or <code>Err</code> with the current
|
||
<code>Box<ParserState></code> otherwise.</p>
|
||
<p>This method is useful to parse sequences that only match together which usually come in the
|
||
form of chained <code>Result</code>s with
|
||
<a href="https://doc.rust-lang.org/std/result/enum.Result.html#method.and_then"><code>Result::and_then</code></a>.</p>
|
||
<h5 id="examples-4"><a href="#examples-4">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {
|
||
<span class="ident">a</span>
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"a"</span>;
|
||
<span class="kw">let</span> <span class="ident">pairs</span>: <span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::state</span>(<span class="ident">input</span>, <span class="op">|</span><span class="ident">state</span><span class="op">|</span> {
|
||
<span class="ident">state</span>.<span class="ident">sequence</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
|
||
<span class="ident">s</span>.<span class="ident">rule</span>(<span class="ident">Rule::a</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="prelude-val">Ok</span>(<span class="ident">s</span>)).<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
|
||
<span class="ident">s</span>.<span class="ident">match_string</span>(<span class="string">"b"</span>)
|
||
})
|
||
}).<span class="ident">or_else</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
|
||
<span class="prelude-val">Ok</span>(<span class="ident">s</span>)
|
||
})
|
||
}).<span class="ident">unwrap</span>().<span class="ident">collect</span>();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="ident">pairs</span>.<span class="ident">len</span>(), <span class="number">0</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.repeat" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#509-522">source</a></span><h4 class="code-header">pub fn <a href="#method.repeat" class="fnname">repeat</a><F>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>, f: F) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>>, </span></h4></section></summary><div class="docblock"><p>Repeatedly applies the transformation provided by <code>f</code> from the <code>Box<ParserState></code>. Returns
|
||
<code>Ok</code> with the updated <code>Box<ParserState></code> returned by <code>f</code> wrapped up in an <code>Err</code>.</p>
|
||
<h5 id="examples-5"><a href="#examples-5">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {
|
||
<span class="ident">ab</span>
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"aab"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">repeat</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
|
||
<span class="ident">s</span>.<span class="ident">match_string</span>(<span class="string">"a"</span>)
|
||
});
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">2</span>);
|
||
|
||
<span class="ident">state</span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">repeat</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
|
||
<span class="ident">s</span>.<span class="ident">match_string</span>(<span class="string">"b"</span>)
|
||
});
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">0</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.optional" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#551-559">source</a></span><h4 class="code-header">pub fn <a href="#method.optional" class="fnname">optional</a><F>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>, f: F) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>>, </span></h4></section></summary><div class="docblock"><p>Optionally applies the transformation provided by <code>f</code> from the <code>Box<ParserState></code>. Returns
|
||
<code>Ok</code> with the updated <code>Box<ParserState></code> returned by <code>f</code> regardless of the <code>Result</code>.</p>
|
||
<h5 id="examples-6"><a href="#examples-6">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {
|
||
<span class="ident">ab</span>
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"ab"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">optional</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
|
||
<span class="ident">s</span>.<span class="ident">match_string</span>(<span class="string">"ab"</span>)
|
||
});
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
|
||
<span class="ident">state</span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">optional</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
|
||
<span class="ident">s</span>.<span class="ident">match_string</span>(<span class="string">"ac"</span>)
|
||
});
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.match_char_by" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#586-595">source</a></span><h4 class="code-header">pub fn <a href="#method.match_char_by" class="fnname">match_char_by</a><F>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>, f: F) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.char.html">char</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a>, </span></h4></section></summary><div class="docblock"><p>Attempts to match a single character based on a filter function. Returns <code>Ok</code> with the
|
||
updated <code>Box<ParserState></code> if successful, or <code>Err</code> with the updated <code>Box<ParserState></code>
|
||
otherwise.</p>
|
||
<h5 id="examples-7"><a href="#examples-7">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"ab"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">match_char_by</span>(<span class="op">|</span><span class="ident">c</span><span class="op">|</span> <span class="ident">c</span>.<span class="ident">is_ascii</span>());
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">1</span>);
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"❤"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">match_char_by</span>(<span class="op">|</span><span class="ident">c</span><span class="op">|</span> <span class="ident">c</span>.<span class="ident">is_ascii</span>());
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">0</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.match_string" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#620-626">source</a></span><h4 class="code-header">pub fn <a href="#method.match_string" class="fnname">match_string</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>, string: &<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.str.html">str</a>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></h4></section></summary><div class="docblock"><p>Attempts to match the given string. Returns <code>Ok</code> with the updated <code>Box<ParserState></code> if
|
||
successful, or <code>Err</code> with the updated <code>Box<ParserState></code> otherwise.</p>
|
||
<h5 id="examples-8"><a href="#examples-8">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"ab"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"ab"</span>);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">2</span>);
|
||
|
||
<span class="ident">state</span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"ac"</span>);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">0</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.match_insensitive" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#651-657">source</a></span><h4 class="code-header">pub fn <a href="#method.match_insensitive" class="fnname">match_insensitive</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>, string: &<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.str.html">str</a>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></h4></section></summary><div class="docblock"><p>Attempts to case-insensitively match the given string. Returns <code>Ok</code> with the updated
|
||
<code>Box<ParserState></code> if successful, or <code>Err</code> with the updated <code>Box<ParserState></code> otherwise.</p>
|
||
<h5 id="examples-9"><a href="#examples-9">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"ab"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">match_insensitive</span>(<span class="string">"AB"</span>);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">2</span>);
|
||
|
||
<span class="ident">state</span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">match_insensitive</span>(<span class="string">"AC"</span>);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">0</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.match_range" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#685-691">source</a></span><h4 class="code-header">pub fn <a href="#method.match_range" class="fnname">match_range</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>, range: <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/ops/range/struct.Range.html" title="struct core::ops::range::Range">Range</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.char.html">char</a>>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></h4></section></summary><div class="docblock"><p>Attempts to match a single character from the given range. Returns <code>Ok</code> with the updated
|
||
<code>Box<ParserState></code> if successful, or <code>Err</code> with the updated <code>Box<ParserState></code> otherwise.</p>
|
||
<h5 id="caution"><a href="#caution">Caution</a></h5>
|
||
<p>The provided <code>range</code> is intepreted as inclusive.</p>
|
||
<h5 id="examples-10"><a href="#examples-10">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"ab"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">match_range</span>(<span class="string">'a'</span>..<span class="string">'z'</span>);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">1</span>);
|
||
|
||
<span class="ident">state</span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">match_range</span>(<span class="string">'A'</span>..<span class="string">'Z'</span>);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">0</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.skip" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#716-722">source</a></span><h4 class="code-header">pub fn <a href="#method.skip" class="fnname">skip</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>, n: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.usize.html">usize</a>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></h4></section></summary><div class="docblock"><p>Attempts to skip <code>n</code> characters forward. Returns <code>Ok</code> with the updated <code>Box<ParserState></code>
|
||
if successful, or <code>Err</code> with the updated <code>Box<ParserState></code> otherwise.</p>
|
||
<h5 id="examples-11"><a href="#examples-11">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"ab"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">skip</span>(<span class="number">1</span>);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">1</span>);
|
||
|
||
<span class="ident">state</span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">skip</span>(<span class="number">3</span>);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">0</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.skip_until" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#742-745">source</a></span><h4 class="code-header">pub fn <a href="#method.skip_until" class="fnname">skip_until</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>, strings: &[&<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.str.html">str</a>]) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></h4></section></summary><div class="docblock"><p>Attempts to skip forward until one of the given strings is found. Returns <code>Ok</code> with the
|
||
updated <code>Box<ParserState></code> whether or not one of the strings is found.</p>
|
||
<h5 id="examples-12"><a href="#examples-12">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"abcd"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">skip_until</span>(<span class="kw-2">&</span>[<span class="string">"c"</span>, <span class="string">"d"</span>]);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">2</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.start_of_input" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#769-775">source</a></span><h4 class="code-header">pub fn <a href="#method.start_of_input" class="fnname">start_of_input</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></h4></section></summary><div class="docblock"><p>Attempts to match the start of the input. Returns <code>Ok</code> with the current <code>Box<ParserState></code>
|
||
if the parser has not yet advanced, or <code>Err</code> with the current <code>Box<ParserState></code> otherwise.</p>
|
||
<h5 id="examples-13"><a href="#examples-13">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"ab"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">start_of_input</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
|
||
<span class="ident">state</span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="ident">state</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"ab"</span>).<span class="ident">unwrap</span>();
|
||
<span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">start_of_input</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.end_of_input" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#799-805">source</a></span><h4 class="code-header">pub fn <a href="#method.end_of_input" class="fnname">end_of_input</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></h4></section></summary><div class="docblock"><p>Attempts to match the end of the input. Returns <code>Ok</code> with the current <code>Box<ParserState></code> if
|
||
there is no input remaining, or <code>Err</code> with the current <code>Box<ParserState></code> otherwise.</p>
|
||
<h5 id="examples-14"><a href="#examples-14">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"ab"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">end_of_input</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
|
||
<span class="ident">state</span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="ident">state</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"ab"</span>).<span class="ident">unwrap</span>();
|
||
<span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">end_of_input</span>();
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.lookahead" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#832-876">source</a></span><h4 class="code-header">pub fn <a href="#method.lookahead" class="fnname">lookahead</a><F>(<br> self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>,<br> is_positive: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.bool.html">bool</a>,<br> f: F<br>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>>, </span></h4></section></summary><div class="docblock"><p>Starts a lookahead transformation provided by <code>f</code> from the <code>Box<ParserState></code>. It returns
|
||
<code>Ok</code> with the current <code>Box<ParserState></code> if <code>f</code> also returns an <code>Ok</code>, or <code>Err</code> with the current
|
||
<code>Box<ParserState></code> otherwise. If <code>is_positive</code> is <code>false</code>, it swaps the <code>Ok</code> and <code>Err</code>
|
||
together, negating the <code>Result</code>.</p>
|
||
<h5 id="examples-15"><a href="#examples-15">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {
|
||
<span class="ident">a</span>
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"a"</span>;
|
||
<span class="kw">let</span> <span class="ident">pairs</span>: <span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::state</span>(<span class="ident">input</span>, <span class="op">|</span><span class="ident">state</span><span class="op">|</span> {
|
||
<span class="ident">state</span>.<span class="ident">lookahead</span>(<span class="bool-val">true</span>, <span class="op">|</span><span class="ident">state</span><span class="op">|</span> {
|
||
<span class="ident">state</span>.<span class="ident">rule</span>(<span class="ident">Rule::a</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="prelude-val">Ok</span>(<span class="ident">s</span>))
|
||
})
|
||
}).<span class="ident">unwrap</span>().<span class="ident">collect</span>();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="ident">pairs</span>.<span class="ident">len</span>(), <span class="number">0</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.atomic" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#900-928">source</a></span><h4 class="code-header">pub fn <a href="#method.atomic" class="fnname">atomic</a><F>(<br> self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>,<br> atomicity: <a class="enum" href="enum.Atomicity.html" title="enum pest::Atomicity">Atomicity</a>,<br> f: F<br>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>>, </span></h4></section></summary><div class="docblock"><p>Transformation which stops <code>Token</code>s from being generated according to <code>is_atomic</code>.</p>
|
||
<h5 id="examples-16"><a href="#examples-16">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {
|
||
<span class="ident">a</span>
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"a"</span>;
|
||
<span class="kw">let</span> <span class="ident">pairs</span>: <span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::state</span>(<span class="ident">input</span>, <span class="op">|</span><span class="ident">state</span><span class="op">|</span> {
|
||
<span class="ident">state</span>.<span class="ident">atomic</span>(<span class="ident">Atomicity::Atomic</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
|
||
<span class="ident">s</span>.<span class="ident">rule</span>(<span class="ident">Rule::a</span>, <span class="op">|</span><span class="ident">s</span><span class="op">|</span> <span class="prelude-val">Ok</span>(<span class="ident">s</span>))
|
||
})
|
||
}).<span class="ident">unwrap</span>().<span class="ident">collect</span>();
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="ident">pairs</span>.<span class="ident">len</span>(), <span class="number">0</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.stack_push" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#949-966">source</a></span><h4 class="code-header">pub fn <a href="#method.stack_push" class="fnname">stack_push</a><F>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>, f: F) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>>, </span></h4></section></summary><div class="docblock"><p>Evaluates the result of closure <code>f</code> and pushes the span of the input consumed from before
|
||
<code>f</code> is called to after <code>f</code> is called to the stack. Returns <code>Ok(Box<ParserState>)</code> if <code>f</code> is
|
||
called successfully, or <code>Err(Box<ParserState>)</code> otherwise.</p>
|
||
<h5 id="examples-17"><a href="#examples-17">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"ab"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">stack_push</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"a"</span>));
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">1</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.stack_peek" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#988-995">source</a></span><h4 class="code-header">pub fn <a href="#method.stack_peek" class="fnname">stack_peek</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></h4></section></summary><div class="docblock"><p>Peeks the top of the stack and attempts to match the string. Returns <code>Ok(Box<ParserState>)</code>
|
||
if the string is matched successfully, or <code>Err(Box<ParserState>)</code> otherwise.</p>
|
||
<h5 id="examples-18"><a href="#examples-18">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"aa"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">stack_push</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"a"</span>)).<span class="ident">and_then</span>(
|
||
<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">stack_peek</span>()
|
||
);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">2</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.stack_pop" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#1017-1024">source</a></span><h4 class="code-header">pub fn <a href="#method.stack_pop" class="fnname">stack_pop</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></h4></section></summary><div class="docblock"><p>Pops the top of the stack and attempts to match the string. Returns <code>Ok(Box<ParserState>)</code>
|
||
if the string is matched successfully, or <code>Err(Box<ParserState>)</code> otherwise.</p>
|
||
<h5 id="examples-19"><a href="#examples-19">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"aa"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">stack_push</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"a"</span>)).<span class="ident">and_then</span>(
|
||
<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">stack_pop</span>()
|
||
);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">2</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.stack_match_peek_slice" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#1051-1081">source</a></span><h4 class="code-header">pub fn <a href="#method.stack_match_peek_slice" class="fnname">stack_match_peek_slice</a>(<br> self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>,<br> start: <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.i32.html">i32</a>,<br> end: <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.i32.html">i32</a>>,<br> match_dir: <a class="enum" href="enum.MatchDir.html" title="enum pest::MatchDir">MatchDir</a><br>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></h4></section></summary><div class="docblock"><p>Matches part of the state of the stack.</p>
|
||
<h5 id="examples-20"><a href="#examples-20">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"abcd cd cb"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>
|
||
.<span class="ident">stack_push</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"a"</span>))
|
||
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">stack_push</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"b"</span>)))
|
||
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">stack_push</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"c"</span>)))
|
||
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">stack_push</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"d"</span>)))
|
||
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">" "</span>))
|
||
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">stack_match_peek_slice</span>(<span class="number">2</span>, <span class="prelude-val">None</span>, <span class="ident">MatchDir::BottomToTop</span>))
|
||
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">" "</span>))
|
||
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">stack_match_peek_slice</span>(<span class="number">1</span>, <span class="prelude-val">Some</span>(<span class="op">-</span><span class="number">1</span>), <span class="ident">MatchDir::TopToBottom</span>));
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">10</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.stack_match_peek" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#1103-1105">source</a></span><h4 class="code-header">pub fn <a href="#method.stack_match_peek" class="fnname">stack_match_peek</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></h4></section></summary><div class="docblock"><p>Matches the full state of the stack.</p>
|
||
<h5 id="examples-21"><a href="#examples-21">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"abba"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>
|
||
.<span class="ident">stack_push</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"a"</span>))
|
||
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> { <span class="ident">state</span>.<span class="ident">stack_push</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"b"</span>)) })
|
||
.<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">stack_match_peek</span>());
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">4</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.stack_match_pop" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#1126-1142">source</a></span><h4 class="code-header">pub fn <a href="#method.stack_match_pop" class="fnname">stack_match_pop</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></h4></section></summary><div class="docblock"><p>Matches the full state of the stack. This method will clear the stack as it evaluates.</p>
|
||
<h5 id="examples-22"><a href="#examples-22">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="doccomment">/// # use pest;</span>
|
||
<span class="kw">enum</span> <span class="ident">Rule</span> {}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"aaaa"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">stack_push</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"a"</span>)).<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> {
|
||
<span class="ident">state</span>.<span class="ident">stack_push</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"a"</span>))
|
||
}).<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">stack_match_peek</span>());
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">4</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.stack_drop" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#1164-1169">source</a></span><h4 class="code-header">pub fn <a href="#method.stack_drop" class="fnname">stack_drop</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>></h4></section></summary><div class="docblock"><p>Drops the top of the stack. Returns <code>Ok(Box<ParserState>)</code> if there was a value to drop, or
|
||
<code>Err(Box<ParserState>)</code> otherwise.</p>
|
||
<h5 id="examples-23"><a href="#examples-23">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"aa"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">stack_push</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"a"</span>)).<span class="ident">and_then</span>(
|
||
<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">stack_drop</span>()
|
||
);
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>.<span class="ident">unwrap</span>().<span class="ident">position</span>().<span class="ident">pos</span>(), <span class="number">1</span>);</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.restore_on_err" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#1195-1203">source</a></span><h4 class="code-header">pub fn <a href="#method.restore_on_err" class="fnname">restore_on_err</a><F>(self: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>, f: F) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>) -> <a class="type" href="type.ParseResult.html" title="type pest::ParseResult">ParseResult</a><<a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><Self>>, </span></h4></section></summary><div class="docblock"><p>Restores the original state of the <code>ParserState</code> when <code>f</code> returns an <code>Err</code>. Currently,
|
||
this method only restores the stack.</p>
|
||
<h5 id="examples-24"><a href="#examples-24">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">enum</span> <span class="ident">Rule</span> {}
|
||
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"ab"</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">state</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">pest::ParserState</span><span class="op"><</span><span class="lifetime">'_</span>, <span class="ident">Rule</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="ident">pest::ParserState::new</span>(<span class="ident">input</span>);
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">state</span>.<span class="ident">restore_on_err</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">stack_push</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span>
|
||
<span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"a"</span>)).<span class="ident">and_then</span>(<span class="op">|</span><span class="ident">state</span><span class="op">|</span> <span class="ident">state</span>.<span class="ident">match_string</span>(<span class="string">"a"</span>))
|
||
);
|
||
|
||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_err</span>());
|
||
|
||
<span class="comment">// Since the the rule doesn't match, the "a" pushed to the stack will be removed.</span>
|
||
<span class="kw">let</span> <span class="ident">catch_panic</span> <span class="op">=</span> <span class="ident">std::panic::catch_unwind</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">result</span>.<span class="ident">unwrap_err</span>().<span class="ident">stack_pop</span>());
|
||
<span class="macro">assert!</span>(<span class="ident">catch_panic</span>.<span class="ident">is_err</span>());</code></pre></div>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-ParserState%3C%27i%2C%20R%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#128">source</a></span><a href="#impl-Debug-for-ParserState%3C%27i%2C%20R%3E" class="anchor"></a><h3 class="code-header in-band">impl<'i, R: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="trait.RuleType.html" title="trait pest::RuleType">RuleType</a>> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.ParserState.html" title="struct pest::ParserState">ParserState</a><'i, R></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/pest/parser_state.rs.html#128">source</a></span><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.64.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.64.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-ParserState%3C%27i%2C%20R%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-ParserState%3C%27i%2C%20R%3E" class="anchor"></a><h3 class="code-header in-band">impl<'i, R> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.ParserState.html" title="struct pest::ParserState">ParserState</a><'i, R> <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>, </span></h3></section><section id="impl-Send-for-ParserState%3C%27i%2C%20R%3E" class="impl has-srclink"><a href="#impl-Send-for-ParserState%3C%27i%2C%20R%3E" class="anchor"></a><h3 class="code-header in-band">impl<'i, R> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.ParserState.html" title="struct pest::ParserState">ParserState</a><'i, R> <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></h3></section><section id="impl-Sync-for-ParserState%3C%27i%2C%20R%3E" class="impl has-srclink"><a href="#impl-Sync-for-ParserState%3C%27i%2C%20R%3E" class="anchor"></a><h3 class="code-header in-band">impl<'i, R> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.ParserState.html" title="struct pest::ParserState">ParserState</a><'i, R> <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></h3></section><section id="impl-Unpin-for-ParserState%3C%27i%2C%20R%3E" class="impl has-srclink"><a href="#impl-Unpin-for-ParserState%3C%27i%2C%20R%3E" class="anchor"></a><h3 class="code-header in-band">impl<'i, R> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.ParserState.html" title="struct pest::ParserState">ParserState</a><'i, R> <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></h3></section><section id="impl-UnwindSafe-for-ParserState%3C%27i%2C%20R%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-ParserState%3C%27i%2C%20R%3E" class="anchor"></a><h3 class="code-header in-band">impl<'i, R> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.ParserState.html" title="struct pest::ParserState">ParserState</a><'i, R> <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>, </span></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-ParserState%3C%27i%2C%20R%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/any.rs.html#203">source</a></span><a href="#impl-Any-for-ParserState%3C%27i%2C%20R%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/any.rs.html#204">source</a></span><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.64.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.64.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-ParserState%3C%27i%2C%20R%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#209">source</a></span><a href="#impl-Borrow%3CT%3E-for-ParserState%3C%27i%2C%20R%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#211">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&</a>T</h4></section></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-ParserState%3C%27i%2C%20R%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#218">source</a></span><a href="#impl-BorrowMut%3CT%3E-for-ParserState%3C%27i%2C%20R%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/borrow.rs.html#219">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.reference.html">&mut </a>T</h4></section></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.64.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-ParserState%3C%27i%2C%20R%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#557">source</a></span><a href="#impl-From%3CT%3E-for-ParserState%3C%27i%2C%20R%3E" class="anchor"></a><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#559">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-ParserState%3C%27i%2C%20R%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#541">source</a></span><a href="#impl-Into%3CU%3E-for-ParserState%3C%27i%2C%20R%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#549">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-ParserState%3C%27i%2C%20R%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#598">source</a></span><a href="#impl-TryFrom%3CU%3E-for-ParserState%3C%27i%2C%20R%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#604">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-ParserState%3C%27i%2C%20R%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#583">source</a></span><a href="#impl-TryInto%3CU%3E-for-ParserState%3C%27i%2C%20R%3E" class="anchor"></a><h3 class="code-header in-band">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/1.64.0/src/core/convert/mod.rs.html#589">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.64.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="pest" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |