blob: acdec46953d248cb6b73913d34aabe90fd27591a [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="API documentation for the Rust `NoExpand` struct in crate `regex`.">
<meta name="keywords" content="rust, rustlang, rust-lang, NoExpand">
<title>regex::NoExpand - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
<link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
</head>
<body class="rustdoc struct">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<a href='../regex/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
<p class='location'>Struct NoExpand</p><div class="block items"><ul><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='index.html'>regex</a></p><script>window.sidebarCurrent = {name: 'NoExpand', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>regex</a>::<wbr><a class="struct" href=''>NoExpand</a></span><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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/regex/re_unicode.rs.html#724' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct NoExpand&lt;'t&gt;(pub &amp;'t <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>);</pre><div class='docblock'><p>NoExpand indicates literal string replacement.</p>
<p>It can be used with <code>replace</code> and <code>replace_all</code> to do a literal
string replacement without expanding <code>$name</code> to their corresponding
capture groups.</p>
<p><code>&#39;t</code> is the lifetime of the literal text.</p>
</div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl&lt;'t&gt; <a class="trait" href="../regex/trait.Replacer.html" title="trait regex::Replacer">Replacer</a> for <a class="struct" href="../regex/struct.NoExpand.html" title="struct regex::NoExpand">NoExpand</a>&lt;'t&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/regex/re_unicode.rs.html#739-747' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.reg_replace' class="method"><span id='reg_replace.v' class='invisible'><code>fn <a href='../regex/trait.Replacer.html#tymethod.reg_replace' class='fnname'>reg_replace</a>(&amp;mut self, _: &amp;<a class="struct" href="../regex/struct.Captures.html" title="struct regex::Captures">Captures</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;</code></span></h4>
<div class='docblock'><p>Returns a possibly owned string that is used to replace the match corresponding to the <code>caps</code> capture group. <a href="../regex/trait.Replacer.html#tymethod.reg_replace">Read more</a></p>
</div><h4 id='method.no_expand' class="method"><span id='no_expand.v' class='invisible'><code>fn <a href='../regex/trait.Replacer.html#method.no_expand' class='fnname'>no_expand</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>&gt;&gt;</code></span></h4>
<div class='docblock'><p>Returns a possibly owned string that never needs expansion.</p>
</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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "regex";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>