34 lines
10 KiB
HTML
34 lines
10 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_transform` macro in crate `nom`."><meta name="keywords" content="rust, rustlang, rust-lang, escaped_transform"><title>nom::escaped_transform - 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 macro"><!--[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='../nom/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>nom</a></p><script>window.sidebarCurrent = {name: 'escaped_transform', ty: 'macro', 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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled 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/nom/bytes.rs.html#293-402' title='goto source code'>[src]</a></span><span class='in-band'>Macro <a href='index.html'>nom</a>::<wbr><a class="macro" href=''>escaped_transform</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><div class="example-wrap"><pre class="rust macro">
|
||
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">escaped_transform</span> {
|
||
(<span class="ident">__impl</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>: <span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">normal</span>:<span class="macro">ident</span><span class="macro">!</span>( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">args</span>:<span class="ident">tt</span>)<span class="op">*</span> ), <span class="macro-nonterminal">$</span><span class="macro-nonterminal">control_char</span>: <span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">transform</span>:<span class="macro">ident</span><span class="macro">!</span>( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">args2</span>:<span class="ident">tt</span>)<span class="op">*</span> )) <span class="op">=</span><span class="op">></span> { ... };
|
||
(<span class="ident">__impl_1</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">submac1</span>:<span class="macro">ident</span><span class="macro">!</span>( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">args</span>:<span class="ident">tt</span>)<span class="op">*</span> ), <span class="macro-nonterminal">$</span><span class="macro-nonterminal">control_char</span>: <span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">submac2</span>:<span class="macro">ident</span><span class="macro">!</span>( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">args2</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) ) <span class="op">=</span><span class="op">></span> { ... };
|
||
(<span class="ident">__impl_1</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">submac1</span>:<span class="macro">ident</span><span class="macro">!</span>( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">args</span>:<span class="ident">tt</span>)<span class="op">*</span> ), <span class="macro-nonterminal">$</span><span class="macro-nonterminal">control_char</span>: <span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">g</span>:<span class="ident">expr</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">submac</span>:<span class="macro">ident</span><span class="macro">!</span>( $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">args</span>:<span class="ident">tt</span>)<span class="op">*</span> ), <span class="macro-nonterminal">$</span><span class="macro-nonterminal">control_char</span>: <span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">rest</span>:<span class="ident">tt</span>)<span class="op">+</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">i</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">f</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">control_char</span>: <span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">rest</span>:<span class="ident">tt</span>)<span class="op">+</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
}</pre></div>
|
||
</div><div class='docblock'><p><code>escaped_transform!(&[T] -> IResult<&[T], &[T]>, T, &[T] -> IResult<&[T], &[T]>) => &[T] -> IResult<&[T], Vec<T>></code>
|
||
matches a byte string with escaped characters.</p>
|
||
<p>The first argument matches the normal characters (it must not match the control character),
|
||
the second argument is the control character (like <code>\</code> in most languages),
|
||
the third argument matches the escaped characters and transforms them.</p>
|
||
<p>As an example, the chain <code>abc\tdef</code> could be <code>abc def</code> (it also consumes the control character)</p>
|
||
<p>WARNING: if you do not use the <code>verbose-errors</code> feature, this combinator will currently fail to build
|
||
because of a type inference error</p>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
<div class='information'><div class='tooltip ignore'>ⓘ<span class='tooltiptext'>This example is not tested</span></div></div><div class="example-wrap"><pre class="rust rust-example-rendered ignore">
|
||
<span class="kw">fn</span> <span class="ident">to_s</span>(<span class="ident">i</span>:<span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">String</span> {
|
||
<span class="ident">String</span>::<span class="ident">from_utf8_lossy</span>(<span class="kw-2">&</span><span class="ident">i</span>).<span class="ident">into_owned</span>()
|
||
}
|
||
<span class="macro">named</span><span class="macro">!</span>(<span class="ident">transform</span> <span class="op"><</span> <span class="ident">String</span> <span class="op">></span>,
|
||
<span class="macro">map</span><span class="macro">!</span>(
|
||
<span class="macro">escaped_transform</span><span class="macro">!</span>(<span class="macro">call</span><span class="macro">!</span>(<span class="ident">alpha</span>), <span class="string">'\\'</span>,
|
||
<span class="macro">alt</span><span class="macro">!</span>(
|
||
<span class="macro">tag</span><span class="macro">!</span>(<span class="string">"\\"</span>) <span class="op">=</span><span class="op">></span> { <span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="kw-2">&</span><span class="string">b"\\"</span>[..] }
|
||
<span class="op">|</span> <span class="macro">tag</span><span class="macro">!</span>(<span class="string">"\""</span>) <span class="op">=</span><span class="op">></span> { <span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="kw-2">&</span><span class="string">b"\""</span>[..] }
|
||
<span class="op">|</span> <span class="macro">tag</span><span class="macro">!</span>(<span class="string">"n"</span>) <span class="op">=</span><span class="op">></span> { <span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="kw-2">&</span><span class="string">b"\n"</span>[..] }
|
||
)
|
||
), <span class="ident">to_s</span>
|
||
)
|
||
);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">transform</span>(<span class="kw-2">&</span><span class="string">b"ab\\\"cd"</span>[..]), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b""</span>[..], <span class="ident">String</span>::<span class="ident">from</span>(<span class="string">"ab\"cd"</span>))));</pre></div>
|
||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "nom";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |