edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-11-09 17:48:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/winnow/token/fn.literal.html
edg-l e933338a23 deploy: ffe3763716
2024-07-26 09:44:36 +00:00

47 lines
8.9 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Recognizes a literal"><title>literal in winnow::token - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="winnow" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc fn"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../winnow/index.html">winnow</a><span class="version">0.6.16</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In winnow::token</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../index.html">winnow</a>::<wbr><a href="index.html">token</a>::<wbr><a class="fn" href="#">literal</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/winnow/token/mod.rs.html#160-176">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn literal&lt;Literal, Input, Error&gt;(
literal: Literal,
) -&gt; impl <a class="trait" href="../trait.Parser.html" title="trait winnow::Parser">Parser</a>&lt;Input, &lt;Input as <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>&gt;::<a class="associatedtype" href="../stream/trait.Stream.html#associatedtype.Slice" title="type winnow::stream::Stream::Slice">Slice</a>, Error&gt;<div class="where">where
Input: <a class="trait" href="../stream/trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a> + <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a> + <a class="trait" href="../stream/trait.Compare.html" title="trait winnow::stream::Compare">Compare</a>&lt;Literal&gt;,
Literal: <a class="trait" href="../stream/trait.SliceLen.html" title="trait winnow::stream::SliceLen">SliceLen</a> + <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,
Error: <a class="trait" href="../error/trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a>&lt;Input&gt;,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Recognizes a literal</p>
<p>The input data will be compared to the literal combinator’s argument and will return the part of
the input that matches the argument</p>
<p>It will return <code>Err(ErrMode::Backtrack(InputError::new(_, ErrorKind::Tag)))</code> if the input doesn’t match the literal</p>
<p><strong>Note:</strong> <a href="../trait.Parser.html" title="trait winnow::Parser"><code>Parser</code></a> is implemented for strings and byte strings as a convenience (complete
only)</p>
<h2 id="effective-signature"><a class="doc-anchor" href="#effective-signature">§</a>Effective Signature</h2>
<p>Assuming you are parsing a <code>&amp;str</code> <a href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">pub fn </span>literal(literal: <span class="kw-2">&amp;</span>str) -&gt; <span class="kw">impl </span>Parser&lt;<span class="kw-2">&amp;</span>str, <span class="kw-2">&amp;</span>str, ContextError&gt;</code></pre></div>
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">fn </span>parser(s: <span class="kw-2">&amp;</span>str) -&gt; IResult&lt;<span class="kw-2">&amp;</span>str, <span class="kw-2">&amp;</span>str&gt; {
<span class="string">"Hello"</span>.parse_peek(s)
}
<span class="macro">assert_eq!</span>(parser(<span class="string">"Hello, World!"</span>), <span class="prelude-val">Ok</span>((<span class="string">", World!"</span>, <span class="string">"Hello"</span>)));
<span class="macro">assert_eq!</span>(parser(<span class="string">"Something"</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="string">"Something"</span>, ErrorKind::Tag))));
<span class="macro">assert_eq!</span>(parser(<span class="string">""</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="string">""</span>, ErrorKind::Tag))));</code></pre></div>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
<span class="kw">fn </span>parser(s: Partial&lt;<span class="kw-2">&amp;</span>str&gt;) -&gt; IResult&lt;Partial&lt;<span class="kw-2">&amp;</span>str&gt;, <span class="kw-2">&amp;</span>str&gt; {
<span class="string">"Hello"</span>.parse_peek(s)
}
<span class="macro">assert_eq!</span>(parser(Partial::new(<span class="string">"Hello, World!"</span>)), <span class="prelude-val">Ok</span>((Partial::new(<span class="string">", World!"</span>), <span class="string">"Hello"</span>)));
<span class="macro">assert_eq!</span>(parser(Partial::new(<span class="string">"Something"</span>)), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(Partial::new(<span class="string">"Something"</span>), ErrorKind::Tag))));
<span class="macro">assert_eq!</span>(parser(Partial::new(<span class="string">"S"</span>)), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(Partial::new(<span class="string">"S"</span>), ErrorKind::Tag))));
<span class="macro">assert_eq!</span>(parser(Partial::new(<span class="string">"H"</span>)), <span class="prelude-val">Err</span>(ErrMode::Incomplete(Needed::new(<span class="number">4</span>))));</code></pre></div>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::token::literal;
<span class="kw">use </span>winnow::ascii::Caseless;
<span class="kw">fn </span>parser(s: <span class="kw-2">&amp;</span>str) -&gt; IResult&lt;<span class="kw-2">&amp;</span>str, <span class="kw-2">&amp;</span>str&gt; {
literal(Caseless(<span class="string">"hello"</span>)).parse_peek(s)
}
<span class="macro">assert_eq!</span>(parser(<span class="string">"Hello, World!"</span>), <span class="prelude-val">Ok</span>((<span class="string">", World!"</span>, <span class="string">"Hello"</span>)));
<span class="macro">assert_eq!</span>(parser(<span class="string">"hello, World!"</span>), <span class="prelude-val">Ok</span>((<span class="string">", World!"</span>, <span class="string">"hello"</span>)));
<span class="macro">assert_eq!</span>(parser(<span class="string">"HeLlO, World!"</span>), <span class="prelude-val">Ok</span>((<span class="string">", World!"</span>, <span class="string">"HeLlO"</span>)));
<span class="macro">assert_eq!</span>(parser(<span class="string">"Something"</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="string">"Something"</span>, ErrorKind::Tag))));
<span class="macro">assert_eq!</span>(parser(<span class="string">""</span>), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="string">""</span>, ErrorKind::Tag))));</code></pre></div>
</div></details></section></div></main></body></html>
Reference in a new issue View git blame Copy permalink