blob: 86cb7c7a93db580d16c4c7d31f470e77226ce7a1 [file] [log] [blame]
<!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/combine-4.6.6/src/parser/char.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>char.rs - source</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" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../combine/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../combine/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><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"><a href="../../../help.html">?</a></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><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
</pre><pre class="rust"><code><span class="doccomment">//! Module containing parsers specialized on character streams.
</span><span class="kw">use crate</span>::{
error::ParseError,
parser::{
combinator::no_partial,
repeat::skip_many,
token::{satisfy, token, tokens_cmp, Token},
},
stream::Stream,
Parser,
};
<span class="doccomment">/// Parses a character and succeeds if the character is equal to `c`.
///
/// ```
/// use combine::Parser;
/// use combine::parser::char::char;
/// assert_eq!(char(&#39;!&#39;).parse(&quot;!&quot;), Ok((&#39;!&#39;, &quot;&quot;)));
/// assert!(char(&#39;A&#39;).parse(&quot;!&quot;).is_err());
/// ```
</span><span class="kw">pub fn </span>char&lt;Input&gt;(c: char) -&gt; Token&lt;Input&gt;
<span class="kw">where
</span>Input: Stream&lt;Token = char&gt;,
Input::Error: ParseError&lt;Input::Token, Input::Range, Input::Position&gt;,
{
token(c)
}
<span class="macro">parser! </span>{
<span class="attribute">#[derive(Copy, Clone)]
</span><span class="kw">pub struct </span>Digit;
<span class="doccomment">/// Parses a base-10 digit.
///
/// ```
/// use combine::Parser;
/// use combine::parser::char::digit;
/// assert_eq!(digit().parse(&quot;9&quot;), Ok((&#39;9&#39;, &quot;&quot;)));
/// assert!(digit().parse(&quot;A&quot;).is_err());
/// ```
</span><span class="kw">pub fn </span>digit[Input]()(Input) -&gt; char
<span class="kw">where
</span>[Input: Stream&lt;Token = char&gt;,]
{
satisfy(|c: char| c.is_digit(<span class="number">10</span>)).expected(<span class="string">&quot;digit&quot;</span>)
}
}
<span class="doccomment">/// Parse a single whitespace according to [`std::char::is_whitespace`].
///
/// This includes space characters, tabs and newlines.
///
/// [`std::char::is_whitespace`]: https://doc.rust-lang.org/std/primitive.char.html#method.is_whitespace
///
/// ```
/// use combine::Parser;
/// use combine::parser::char::space;
/// assert_eq!(space().parse(&quot; &quot;), Ok((&#39; &#39;, &quot;&quot;)));
/// assert_eq!(space().parse(&quot; &quot;), Ok((&#39; &#39;, &quot; &quot;)));
/// assert!(space().parse(&quot;!&quot;).is_err());
/// assert!(space().parse(&quot;&quot;).is_err());
/// ```
</span><span class="kw">pub fn </span>space&lt;Input&gt;() -&gt; <span class="kw">impl </span>Parser&lt;Input, Output = char, PartialState = ()&gt;
<span class="kw">where
</span>Input: Stream&lt;Token = char&gt;,
Input::Error: ParseError&lt;Input::Token, Input::Range, Input::Position&gt;,
{
<span class="kw">let </span>f: <span class="kw">fn</span>(char) -&gt; bool = char::is_whitespace;
satisfy(f).expected(<span class="string">&quot;whitespace&quot;</span>)
}
<span class="doccomment">/// Skips over zero or more spaces according to [`std::char::is_whitespace`].
///
/// This includes space characters, tabs and newlines.
///
/// [`std::char::is_whitespace`]: https://doc.rust-lang.org/std/primitive.char.html#method.is_whitespace
///
/// ```
/// use combine::Parser;
/// use combine::parser::char::spaces;
/// assert_eq!(spaces().parse(&quot;&quot;), Ok(((), &quot;&quot;)));
/// assert_eq!(spaces().parse(&quot; &quot;), Ok(((), &quot;&quot;)));
/// ```
</span><span class="kw">pub fn </span>spaces&lt;Input&gt;() -&gt; <span class="kw">impl </span>Parser&lt;Input, Output = ()&gt;
<span class="kw">where
</span>Input: Stream&lt;Token = char&gt;,
Input::Error: ParseError&lt;Input::Token, Input::Range, Input::Position&gt;,
{
skip_many(space()).expected(<span class="string">&quot;whitespaces&quot;</span>)
}
<span class="doccomment">/// Parses a newline character (`&#39;\n&#39;`).
///
/// ```
/// use combine::Parser;
/// use combine::parser::char::newline;
/// assert_eq!(newline().parse(&quot;\n&quot;), Ok((&#39;\n&#39;, &quot;&quot;)));
/// assert!(newline().parse(&quot;\r&quot;).is_err());
/// ```
</span><span class="kw">pub fn </span>newline&lt;Input&gt;() -&gt; <span class="kw">impl </span>Parser&lt;Input, Output = char, PartialState = ()&gt;
<span class="kw">where
</span>Input: Stream&lt;Token = char&gt;,
Input::Error: ParseError&lt;Input::Token, Input::Range, Input::Position&gt;,
{
satisfy(|ch: char| ch == <span class="string">&#39;\n&#39;</span>).expected(<span class="string">&quot;lf newline&quot;</span>)
}
<span class="doccomment">/// Parses carriage return and newline (`&quot;\r\n&quot;`), returning the newline character.
///
/// ```
/// use combine::Parser;
/// use combine::parser::char::crlf;
/// assert_eq!(crlf().parse(&quot;\r\n&quot;), Ok((&#39;\n&#39;, &quot;&quot;)));
/// assert!(crlf().parse(&quot;\r&quot;).is_err());
/// assert!(crlf().parse(&quot;\n&quot;).is_err());
/// ```
</span><span class="kw">pub fn </span>crlf&lt;Input&gt;() -&gt; <span class="kw">impl </span>Parser&lt;Input, Output = char, PartialState = ()&gt;
<span class="kw">where
</span>Input: Stream&lt;Token = char&gt;,
Input::Error: ParseError&lt;Input::Token, Input::Range, Input::Position&gt;,
{
no_partial(satisfy(|ch: char| ch == <span class="string">&#39;\r&#39;</span>).with(newline())).expected(<span class="string">&quot;crlf newline&quot;</span>)
}
<span class="doccomment">/// Parses a tab character (`&#39;\t&#39;`).
///
/// ```
/// use combine::Parser;
/// use combine::parser::char::tab;
/// assert_eq!(tab().parse(&quot;\t&quot;), Ok((&#39;\t&#39;, &quot;&quot;)));
/// assert!(tab().parse(&quot; &quot;).is_err());
/// ```
</span><span class="kw">pub fn </span>tab&lt;Input&gt;() -&gt; <span class="kw">impl </span>Parser&lt;Input, Output = char, PartialState = ()&gt;
<span class="kw">where
</span>Input: Stream&lt;Token = char&gt;,
Input::Error: ParseError&lt;Input::Token, Input::Range, Input::Position&gt;,
{
satisfy(|ch: char| ch == <span class="string">&#39;\t&#39;</span>).expected(<span class="string">&quot;tab&quot;</span>)
}
<span class="doccomment">/// Parses an uppercase letter according to [`std::char::is_uppercase`].
///
/// [`std::char::is_uppercase`]: https://doc.rust-lang.org/std/primitive.char.html#method.is_uppercase
///
/// ```
/// use combine::Parser;
/// use combine::parser::char::upper;
/// assert_eq!(upper().parse(&quot;A&quot;), Ok((&#39;A&#39;, &quot;&quot;)));
/// assert!(upper().parse(&quot;a&quot;).is_err());
/// ```
</span><span class="kw">pub fn </span>upper&lt;Input&gt;() -&gt; <span class="kw">impl </span>Parser&lt;Input, Output = char, PartialState = ()&gt;
<span class="kw">where
</span>Input: Stream&lt;Token = char&gt;,
Input::Error: ParseError&lt;Input::Token, Input::Range, Input::Position&gt;,
{
satisfy(|ch: char| ch.is_uppercase()).expected(<span class="string">&quot;uppercase letter&quot;</span>)
}
<span class="doccomment">/// Parses an lowercase letter according to [`std::char::is_lowercase`].
///
/// [`std::char::is_lowercase`]: https://doc.rust-lang.org/std/primitive.char.html#method.is_lowercase
///
/// ```
/// use combine::Parser;
/// use combine::parser::char::lower;
/// assert_eq!(lower().parse(&quot;a&quot;), Ok((&#39;a&#39;, &quot;&quot;)));
/// assert!(lower().parse(&quot;A&quot;).is_err());
/// ```
</span><span class="kw">pub fn </span>lower&lt;Input&gt;() -&gt; <span class="kw">impl </span>Parser&lt;Input, Output = char, PartialState = ()&gt;
<span class="kw">where
</span>Input: Stream&lt;Token = char&gt;,
Input::Error: ParseError&lt;Input::Token, Input::Range, Input::Position&gt;,
{
satisfy(|ch: char| ch.is_lowercase()).expected(<span class="string">&quot;lowercase letter&quot;</span>)
}
<span class="doccomment">/// Parses either an alphabet letter or digit according to [`std::char::is_alphanumeric`].
///
/// [`std::char::is_alphanumeric`]: https://doc.rust-lang.org/std/primitive.char.html#method.is_alphanumeric
///
/// ```
/// use combine::Parser;
/// use combine::parser::char::alpha_num;
/// assert_eq!(alpha_num().parse(&quot;A&quot;), Ok((&#39;A&#39;, &quot;&quot;)));
/// assert_eq!(alpha_num().parse(&quot;1&quot;), Ok((&#39;1&#39;, &quot;&quot;)));
/// assert!(alpha_num().parse(&quot;!&quot;).is_err());
/// ```
</span><span class="kw">pub fn </span>alpha_num&lt;Input&gt;() -&gt; <span class="kw">impl </span>Parser&lt;Input, Output = char, PartialState = ()&gt;
<span class="kw">where
</span>Input: Stream&lt;Token = char&gt;,
Input::Error: ParseError&lt;Input::Token, Input::Range, Input::Position&gt;,
{
satisfy(|ch: char| ch.is_alphanumeric()).expected(<span class="string">&quot;letter or digit&quot;</span>)
}
<span class="doccomment">/// Parses an alphabet letter according to [`std::char::is_alphabetic`].
///
/// [`std::char::is_alphabetic`]: https://doc.rust-lang.org/std/primitive.char.html#method.is_alphabetic
///
/// ```
/// use combine::Parser;
/// use combine::parser::char::letter;
/// assert_eq!(letter().parse(&quot;a&quot;), Ok((&#39;a&#39;, &quot;&quot;)));
/// assert_eq!(letter().parse(&quot;A&quot;), Ok((&#39;A&#39;, &quot;&quot;)));
/// assert!(letter().parse(&quot;9&quot;).is_err());
/// ```
</span><span class="kw">pub fn </span>letter&lt;Input&gt;() -&gt; <span class="kw">impl </span>Parser&lt;Input, Output = char, PartialState = ()&gt;
<span class="kw">where
</span>Input: Stream&lt;Token = char&gt;,
Input::Error: ParseError&lt;Input::Token, Input::Range, Input::Position&gt;,
{
satisfy(|ch: char| ch.is_alphabetic()).expected(<span class="string">&quot;letter&quot;</span>)
}
<span class="doccomment">/// Parses an octal digit.
///
/// ```
/// use combine::Parser;
/// use combine::parser::char::oct_digit;
/// assert_eq!(oct_digit().parse(&quot;7&quot;), Ok((&#39;7&#39;, &quot;&quot;)));
/// assert!(oct_digit().parse(&quot;8&quot;).is_err());
/// ```
</span><span class="kw">pub fn </span>oct_digit&lt;Input&gt;() -&gt; <span class="kw">impl </span>Parser&lt;Input, Output = char, PartialState = ()&gt;
<span class="kw">where
</span>Input: Stream&lt;Token = char&gt;,
Input::Error: ParseError&lt;Input::Token, Input::Range, Input::Position&gt;,
{
satisfy(|ch: char| ch.is_digit(<span class="number">8</span>)).expected(<span class="string">&quot;octal digit&quot;</span>)
}
<span class="doccomment">/// Parses a hexdecimal digit with uppercase and lowercase.
///
/// ```
/// use combine::Parser;
/// use combine::parser::char::hex_digit;
/// assert_eq!(hex_digit().parse(&quot;F&quot;), Ok((&#39;F&#39;, &quot;&quot;)));
/// assert!(hex_digit().parse(&quot;H&quot;).is_err());
/// ```
</span><span class="kw">pub fn </span>hex_digit&lt;Input&gt;() -&gt; <span class="kw">impl </span>Parser&lt;Input, Output = char, PartialState = ()&gt;
<span class="kw">where
</span>Input: Stream&lt;Token = char&gt;,
Input::Error: ParseError&lt;Input::Token, Input::Range, Input::Position&gt;,
{
satisfy(|ch: char| ch.is_digit(<span class="number">0x10</span>)).expected(<span class="string">&quot;hexadecimal digit&quot;</span>)
}
<span class="doccomment">/// Parses the string `s`.
///
/// ```
/// # extern crate combine;
/// # use combine::*;
/// # use combine::parser::char::string;
/// # fn main() {
/// let result = string(&quot;rust&quot;)
/// .parse(&quot;rust&quot;)
/// .map(|x| x.0);
/// assert_eq!(result, Ok(&quot;rust&quot;));
/// # }
/// ```
</span><span class="kw">pub fn </span>string&lt;<span class="lifetime">&#39;a</span>, Input&gt;(s: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str) -&gt; <span class="kw">impl </span>Parser&lt;Input, Output = <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str&gt;
<span class="kw">where
</span>Input: Stream&lt;Token = char&gt;,
Input::Error: ParseError&lt;Input::Token, Input::Range, Input::Position&gt;,
{
string_cmp(s, |l, r| l == r)
}
<span class="doccomment">/// Parses the string `s`, using `cmp` to compare each character.
///
/// ```
/// # extern crate combine;
/// # use combine::*;
/// # use combine::parser::char::string_cmp;
/// # fn main() {
/// let result = string_cmp(&quot;rust&quot;, |l, r| l.eq_ignore_ascii_case(&amp;r))
/// .parse(&quot;RusT&quot;)
/// .map(|x| x.0);
/// assert_eq!(result, Ok(&quot;rust&quot;));
/// # }
/// ```
</span><span class="kw">pub fn </span>string_cmp&lt;<span class="lifetime">&#39;a</span>, C, Input&gt;(s: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str, cmp: C) -&gt; <span class="kw">impl </span>Parser&lt;Input, Output = <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str&gt;
<span class="kw">where
</span>C: FnMut(char, char) -&gt; bool,
Input: Stream&lt;Token = char&gt;,
Input::Error: ParseError&lt;Input::Token, Input::Range, Input::Position&gt;,
{
tokens_cmp(s.chars(), cmp).map(<span class="kw">move </span>|<span class="kw">_</span>| s).expected(s)
}
<span class="attribute">#[cfg(all(feature = <span class="string">&quot;std&quot;</span>, test))]
</span><span class="kw">mod </span>tests {
<span class="kw">use crate</span>::{
parser::EasyParser,
stream::{
easy::{Error, Errors},
position::{<span class="self">self</span>, SourcePosition},
},
};
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="attribute">#[test]
</span><span class="kw">fn </span>space_error() {
<span class="kw">let </span>result = space().easy_parse(<span class="string">&quot;&quot;</span>);
<span class="macro">assert!</span>(result.is_err());
<span class="macro">assert_eq!</span>(
result.unwrap_err().errors,
<span class="macro">vec!</span>[Error::end_of_input(), Error::Expected(<span class="string">&quot;whitespace&quot;</span>.into())]
);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>string_committed() {
<span class="kw">let </span>result = string(<span class="string">&quot;a&quot;</span>).easy_parse(position::Stream::new(<span class="string">&quot;b&quot;</span>));
<span class="macro">assert!</span>(result.is_err());
<span class="macro">assert_eq!</span>(
result.unwrap_err().position,
SourcePosition { line: <span class="number">1</span>, column: <span class="number">1 </span>}
);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>string_error() {
<span class="kw">let </span>result = string(<span class="string">&quot;abc&quot;</span>).easy_parse(position::Stream::new(<span class="string">&quot;bc&quot;</span>));
<span class="macro">assert_eq!</span>(
result,
<span class="prelude-val">Err</span>(Errors {
position: SourcePosition { line: <span class="number">1</span>, column: <span class="number">1 </span>},
errors: <span class="macro">vec!</span>[Error::Unexpected(<span class="string">&#39;b&#39;</span>.into()), Error::Expected(<span class="string">&quot;abc&quot;</span>.into())],
})
);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="combine" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>