26 lines
6.5 KiB
HTML
26 lines
6.5 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="Testing tool that compares produced errors."><meta name="keywords" content="rust, rustlang, rust-lang, fails_with"><title>fails_with 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 macro"><!--[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><div class="sidebar-elems"><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">Macro <a href="index.html">pest</a>::<wbr><a class="macro" href="#">fails_with</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/macros.rs.html#289-315">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"><div class="example-wrap"><pre class="rust macro"><code><span class="macro">macro_rules!</span> <span class="ident">fails_with</span> {
|
||
( <span class="ident">parser</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">parser</span>:<span class="ident">ident</span>, <span class="ident">input</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">string</span>:<span class="ident">expr</span>, <span class="ident">rule</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">rules</span>:<span class="ident">tt</span> :: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">rule</span>:<span class="ident">tt</span>,
|
||
<span class="ident">positives</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">positives</span>:<span class="ident">expr</span>, <span class="ident">negatives</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">negatives</span>:<span class="ident">expr</span>, <span class="ident">pos</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">pos</span>:<span class="ident">expr</span> ) => { ... };
|
||
}</code></pre></div>
|
||
</div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Testing tool that compares produced errors.</p>
|
||
<p>This macro takes several arguments:</p>
|
||
<ul>
|
||
<li><code>parser</code> - name of the data structure implementing <code>Parser</code></li>
|
||
<li><code>input</code> - input to be tested against</li>
|
||
<li><code>rule</code> - <code>Rule</code> which will be run</li>
|
||
<li><code>positives</code> - positive <code>Rule</code> attempts that failed</li>
|
||
<li><code>negatives</code> - negative <code>Rule</code> attempts that failed</li>
|
||
<li><code>pos</code> - byte position of failure</li>
|
||
</ul>
|
||
<h2 id="examples"><a href="#examples">Examples</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">fails_with!</span> {
|
||
<span class="ident">parser</span>: <span class="ident">AbcParser</span>,
|
||
<span class="ident">input</span>: <span class="string">"abcdf"</span>,
|
||
<span class="ident">rule</span>: <span class="ident">Rule::a</span>,
|
||
<span class="ident">positives</span>: <span class="macro">vec!</span>[<span class="ident">Rule::c</span>],
|
||
<span class="ident">negatives</span>: <span class="macro">vec!</span>[],
|
||
<span class="ident">pos</span>: <span class="number">4</span>
|
||
};</code></pre></div>
|
||
</div></details></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> |