<!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 `Replacer` trait in crate `regex`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Replacer">
<title>regex::Replacer - Rust</title>
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'><a href='index.html'>regex</a></p><script>window.sidebarCurrent = {name: 'Replacer', ty: 'trait', 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 trait">
<h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>regex</a>::<wbr><a class='trait' href=''>Replacer</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'>−</span>]
</a>
</span><a class='srclink' href='../src/regex/re_unicode.rs.html#1178-1198' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait Replacer {
fn <a href='#tymethod.replace_append' class='fnname'>replace_append</a>(&mut self, caps: &<a class='struct' href='../regex/struct.Captures.html' title='regex::Captures'>Captures</a>, dst: &mut <a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>);
fn <a href='#method.no_expansion' class='fnname'>no_expansion</a><'r>(&'r mut self) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a><<a class='enum' href='https://doc.rust-lang.org/nightly/collections/borrow/enum.Cow.html' title='collections::borrow::Cow'>Cow</a><'r, <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>>> { ... }
}</pre><div class='docblock'><p>Replacer describes types that can be used to replace matches in a string.</p>
<p>In general, users of this crate shouldn't need to implement this trait,
since implementations are already provided for <code>&str</code> and
<code>FnMut(&Captures) -> String</code>, which covers most use cases.</p>
</div>
<h2 id='required-methods'>Required Methods</h2>
<div class='methods'>
<h3 id='tymethod.replace_append' class='method stab '><span id='replace_append.v' class='invisible'><code>fn <a href='#tymethod.replace_append' class='fnname'>replace_append</a>(&mut self, caps: &<a class='struct' href='../regex/struct.Captures.html' title='regex::Captures'>Captures</a>, dst: &mut <a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a>)</code></span></h3><div class='docblock'><p>Appends text to <code>dst</code> to replace the current match.</p>
<p>The current match is represented by <code>caps</code>, which is guaranteed to
have a match at capture group <code>0</code>.</p>
<p>For example, a no-op replacement would be
<code>dst.extend(caps.get(0).unwrap().as_str())</code>.</p>
</div></div>
<h2 id='provided-methods'>Provided Methods</h2>
<div class='methods'>
<h3 id='method.no_expansion' class='method stab '><span id='no_expansion.v' class='invisible'><code>fn <a href='#method.no_expansion' class='fnname'>no_expansion</a><'r>(&'r mut self) -> <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a><<a class='enum' href='https://doc.rust-lang.org/nightly/collections/borrow/enum.Cow.html' title='collections::borrow::Cow'>Cow</a><'r, <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a>>></code></span></h3><div class='docblock'><p>Return a fixed unchanging replacement string.</p>
<p>When doing replacements, if access to <code>Captures</code> is not needed (e.g.,
the replacement byte string does not need <code>$</code> expansion), then it can
be beneficial to avoid finding sub-captures.</p>
<p>In general, this is called once for every call to <code>replacen</code>.</p>
</div></div>
<h2 id='implementors'>Implementors</h2>
<ul class='item-list' id='implementors-list'>
<li><code>impl<'a> Replacer for &'a <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.str.html'>str</a></code></li>
<li><code>impl<F> Replacer for F <span class='where'>where F: <a class='trait' href='https://doc.rust-lang.org/nightly/core/ops/trait.FnMut.html' title='core::ops::FnMut'>FnMut</a>(&<a class='struct' href='../regex/struct.Captures.html' title='regex::Captures'>Captures</a>) -> <a class='struct' href='https://doc.rust-lang.org/nightly/collections/string/struct.String.html' title='collections::string::String'>String</a></span></code></li>
<li><code>impl<'t> Replacer for <a class='struct' href='../regex/struct.NoExpand.html' title='regex::NoExpand'>NoExpand</a><'t></code></li>
</ul><script type="text/javascript" async
src="../implementors/regex/trait.Replacer.js">
</script></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>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</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="../jquery.js"></script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>