mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-28 14:10:42 +00:00
17 lines
8.1 KiB
HTML
17 lines
8.1 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="API documentation for the Rust `escaped` fn in crate `combine`."><meta name="keywords" content="rust, rustlang, rust-lang, escaped"><title>combine::parser::repeat::escaped - Rust</title><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="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../combine/index.html'><img src='../../../rust-logo.png' alt='logo' width='100'></a><div class="sidebar-elems"><p class='location'><a href='../../index.html'>combine</a>::<wbr><a href='../index.html'>parser</a>::<wbr><a href='index.html'>repeat</a></p><script>window.sidebarCurrent = {name: 'escaped', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../../src/combine/parser/repeat.rs.html#1311-1326' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='../../index.html'>combine</a>::<wbr><a href='../index.html'>parser</a>::<wbr><a href='index.html'>repeat</a>::<wbr><a class="fn" href=''>escaped</a></span></h1><pre class='rust fn'>pub fn escaped<P, Q>(<br> parser: P, <br> escape: <P::<a class="type" href="../../../combine/trait.Parser.html#associatedtype.Input" title="type combine::Parser::Input">Input</a> as <a class="trait" href="../../../combine/trait.StreamOnce.html" title="trait combine::StreamOnce">StreamOnce</a>>::<a class="type" href="../../../combine/trait.StreamOnce.html#associatedtype.Item" title="type combine::StreamOnce::Item">Item</a>, <br> escape_parser: Q<br>) -> <a class="struct" href="../../../combine/parser/repeat/struct.Escaped.html" title="struct combine::parser::repeat::Escaped">Escaped</a><P, Q> <span class="where fmt-newline">where<br> P: <a class="trait" href="../../../combine/trait.Parser.html" title="trait combine::Parser">Parser</a>,<br> <P::<a class="type" href="../../../combine/trait.Parser.html#associatedtype.Input" title="type combine::Parser::Input">Input</a> as <a class="trait" href="../../../combine/trait.StreamOnce.html" title="trait combine::StreamOnce">StreamOnce</a>>::<a class="type" href="../../../combine/trait.StreamOnce.html#associatedtype.Item" title="type combine::StreamOnce::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>,<br> Q: <a class="trait" href="../../../combine/trait.Parser.html" title="trait combine::Parser">Parser</a><Input = P::<a class="type" href="../../../combine/trait.Parser.html#associatedtype.Input" title="type combine::Parser::Input">Input</a>>, </span></pre><div class='docblock'><p>Parses an escaped string by first applying <code>parser</code> which accept the normal characters which do
|
||
not need escaping. Once <code>parser</code> can not consume any more input it checks if the next item
|
||
is <code>escape</code>. If it is then <code>escape_parser</code> is used to parse the escaped character and then
|
||
resumes parsing using <code>parser</code>. If <code>escape</code> was not found then the parser finishes
|
||
successfully.</p>
|
||
<p>This returns <code>()</code> since there isn't a good way to collect the output of the parsers so it is
|
||
best paired with one of the <code>recognize</code> parsers.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">parser</span> <span class="op">=</span> <span class="ident">recognize</span>(
|
||
<span class="ident">escaped</span>(<span class="ident">take_while1</span>(<span class="op">|</span><span class="ident">c</span><span class="op">|</span> <span class="ident">c</span> <span class="op">!=</span> <span class="string">'"'</span> <span class="op">&&</span> <span class="ident">c</span> <span class="op">!=</span> <span class="string">'\\'</span>), <span class="string">'\\'</span>, <span class="ident">one_of</span>(<span class="string">r#"nr"\"#</span>.<span class="ident">chars</span>()))
|
||
);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">parser</span>.<span class="ident">parse</span>(<span class="string">r#"ab\"12\n\rc""#</span>), <span class="prelude-val">Ok</span>((<span class="string">r#"ab\"12\n\rc"#</span>, <span class="string">r#"""#</span>)));
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">parser</span>.<span class="ident">parse</span>(<span class="string">r#"\"#</span>).<span class="ident">is_err</span>());
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">parser</span>.<span class="ident">parse</span>(<span class="string">r#"\a"#</span>).<span class="ident">is_err</span>());
|
||
}</pre></div>
|
||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "combine";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |