56 lines
6.2 KiB
HTML
56 lines
6.2 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 `new_escape` macro in crate `v_escape`."><meta name="keywords" content="rust, rustlang, rust-lang, new_escape"><title>v_escape::new_escape - 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='../v_escape/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'>v_escape</a></p><script>window.sidebarCurrent = {name: 'new_escape', 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/v_escape/lib.rs.html#182-212' title='goto source code'>[src]</a></span><span class='in-band'>Macro <a href='index.html'>v_escape</a>::<wbr><a class="macro" href=''>new_escape</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">new_escape</span> {
|
||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">pairs</span>:<span class="ident">expr</span>) <span class="op">=</span><span class="op">></span> { ... };
|
||
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">name</span>:<span class="ident">ident</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">pairs</span>:<span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">t</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>Generates struct <code>$name</code> with escaping functionality at <code>fmt</code></p>
|
||
<p>It will get as input:</p>
|
||
<ul>
|
||
<li>
|
||
<p>$<strong>name</strong>: Name of escape class.</p>
|
||
</li>
|
||
<li>
|
||
<p>$<strong>pairs</strong>: Pairs of <code>[character]->[quote] || [character]->[quote]</code> or
|
||
<code>[character]->[quote]</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p>$<strong>t</strong>: Optional boolean parameters (simd, avx, sse, print).</p>
|
||
<ul>
|
||
<li><strong>simd</strong>: If true (by default), simd optimizations are enabled. When false,
|
||
no matter value of avx, <code>sse4.2</code> will be used,</li>
|
||
<li><strong>avx</strong>: If true (by default), avx optimization are enabled. When false,
|
||
<code>sse2</code>(if <code>ranges=true</code> and <code>simd=true</code>) or <code>scalar</code>(if <code>simd=false</code>) will be used.</li>
|
||
<li><strong>ranges</strong>: If true (by default), ranges optimizations are enabled. When false,
|
||
<code>sse4.2</code>(if <code>simd=true</code>) or <code>scalar</code>(if <code>simd=false</code>) will be used.</li>
|
||
<li><strong>print</strong>: If true (false by default), prints out generated code to console.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p>and will:</p>
|
||
<ol>
|
||
<li>
|
||
<p>Import <code>std::fmt::{self, Display, Formatter}</code></p>
|
||
</li>
|
||
<li>
|
||
<p>Define basic struct with attribute <code>bytes</code> and <code>Escape</code>
|
||
derive functionality</p>
|
||
</li>
|
||
<li>
|
||
<p>Implements for <code>$name</code> constructors <code>new</code> and <code>From<&'a str></code></p>
|
||
</li>
|
||
<li>
|
||
<p>Implements trait <code>Display</code> for <code>$name</code> with escape functionality</p>
|
||
</li>
|
||
<li>
|
||
<p>Implements function <code>escape(&str) -> $name</code></p>
|
||
</li>
|
||
</ol>
|
||
<h4 id="example" class="section-header"><a href="#example">Example</a></h4>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">v_escape</span>;
|
||
|
||
<span class="macro">new_escape</span><span class="macro">!</span>(<span class="ident">MyEscape</span>, <span class="string">"o->bar"</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">escape</span>(<span class="string">"foobar"</span>).<span class="ident">to_string</span>(), <span class="string">"fbarbarbar"</span>);</pre></div>
|
||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "v_escape";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |