44 lines
20 KiB
HTML
44 lines
20 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 `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="../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 trait"><!--[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='../regex/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait Replacer</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.replace_append">replace_append</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.by_ref">by_ref</a><a href="#method.no_expansion">no_expansion</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Replacer-for-%26%27a%20str">&'a str</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><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></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/regex/re_unicode.rs.html#1112-1157' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>regex</a>::<wbr><a class="trait" href=''>Replacer</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><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="struct regex::Captures">Captures</a>, dst: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::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="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'r, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.by_ref' class='fnname'>by_ref</a><'r>(&'r mut self) -> <a class="struct" href="../regex/struct.ReplacerRef.html" title="struct regex::ReplacerRef">ReplacerRef</a><'r, Self> { ... }
|
||
}</pre></div><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> (or any <code>FnMut(&Captures) -> T</code>
|
||
where <code>T: AsRef<str></code>), which covers most use cases.</p>
|
||
</div>
|
||
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.replace_append' class='method'><code id='replace_append.v'>fn <a href='#tymethod.replace_append' class='fnname'>replace_append</a>(&mut self, caps: &<a class="struct" href="../regex/struct.Captures.html" title="struct regex::Captures">Captures</a>, dst: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></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><span class='loading-content'>Loading content...</span>
|
||
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.no_expansion' class='method'><code id='no_expansion.v'>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="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'r, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>></code></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><h3 id='method.by_ref' class='method'><code id='by_ref.v'>fn <a href='#method.by_ref' class='fnname'>by_ref</a><'r>(&'r mut self) -> <a class="struct" href="../regex/struct.ReplacerRef.html" title="struct regex::ReplacerRef">ReplacerRef</a><'r, Self></code></h3><div class='docblock'><p>Return a <code>Replacer</code> that borrows and wraps this <code>Replacer</code>.</p>
|
||
<p>This is useful when you want to take a generic <code>Replacer</code> (which might
|
||
not be cloneable) and use it without consuming it, so it can be used
|
||
more than once.</p>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">regex</span>::{<span class="ident">Regex</span>, <span class="ident">Replacer</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">replace_all_twice</span><span class="op"><</span><span class="ident">R</span>: <span class="ident">Replacer</span><span class="op">></span>(
|
||
<span class="ident">re</span>: <span class="ident">Regex</span>,
|
||
<span class="ident">src</span>: <span class="kw-2">&</span><span class="ident">str</span>,
|
||
<span class="kw-2">mut</span> <span class="ident">rep</span>: <span class="ident">R</span>,
|
||
) <span class="op">-></span> <span class="ident">String</span> {
|
||
<span class="kw">let</span> <span class="ident">dst</span> <span class="op">=</span> <span class="ident">re</span>.<span class="ident">replace_all</span>(<span class="ident">src</span>, <span class="ident">rep</span>.<span class="ident">by_ref</span>());
|
||
<span class="kw">let</span> <span class="ident">dst</span> <span class="op">=</span> <span class="ident">re</span>.<span class="ident">replace_all</span>(<span class="kw-2">&</span><span class="ident">dst</span>, <span class="ident">rep</span>.<span class="ident">by_ref</span>());
|
||
<span class="ident">dst</span>.<span class="ident">into_owned</span>()
|
||
}</pre></div>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-Replacer-for-%26%27a%20str' class='impl'><code class='in-band'>impl<'a> <a class="trait" href="../regex/trait.Replacer.html" title="trait regex::Replacer">Replacer</a> for &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code><a href='#impl-Replacer-for-%26%27a%20str' class='anchor'></a><a class='srclink' href='../src/regex/re_unicode.rs.html#1174-1185' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.replace_append' class="method hidden"><code id='replace_append.v-1'>fn <a href='#method.replace_append' class='fnname'>replace_append</a>(&mut self, caps: &<a class="struct" href="../regex/struct.Captures.html" title="struct regex::Captures">Captures</a>, dst: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code><a class='srclink' href='../src/regex/re_unicode.rs.html#1175-1177' title='goto source code'>[src]</a></h4><h4 id='method.no_expansion-1' class="method hidden"><code id='no_expansion.v-1'>fn <a href='#method.no_expansion' class='fnname'>no_expansion</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>></code><a class='srclink' href='../src/regex/re_unicode.rs.html#1179-1184' title='goto source code'>[src]</a></h4><h4 id='method.by_ref-1' class="method"><code id='by_ref.v-1'>fn <a href='../regex/trait.Replacer.html#method.by_ref' class='fnname'>by_ref</a><'r>(&'r mut self) -> <a class="struct" href="../regex/struct.ReplacerRef.html" title="struct regex::ReplacerRef">ReplacerRef</a><'r, Self></code><a class='srclink' href='../src/regex/re_unicode.rs.html#1154-1156' title='goto source code'>[src]</a></h4></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-Replacer' class='impl'><code class='in-band'>impl<'a, R: <a class="trait" href="../regex/trait.Replacer.html" title="trait regex::Replacer">Replacer</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + 'a> Replacer for <a class="struct" href="../regex/struct.ReplacerRef.html" title="struct regex::ReplacerRef">ReplacerRef</a><'a, R></code><a href='#impl-Replacer' class='anchor'></a><a class='srclink' href='../src/regex/re_unicode.rs.html#1165-1172' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.replace_append-1' class="method hidden"><code id='replace_append.v-2'>fn <a href='#method.replace_append-1' class='fnname'>replace_append</a>(&mut self, caps: &<a class="struct" href="../regex/struct.Captures.html" title="struct regex::Captures">Captures</a>, dst: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code><a class='srclink' href='../src/regex/re_unicode.rs.html#1166-1168' title='goto source code'>[src]</a></h4><h4 id='method.no_expansion-2' class="method hidden"><code id='no_expansion.v-2'>fn <a href='#method.no_expansion-2' class='fnname'>no_expansion</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>></code><a class='srclink' href='../src/regex/re_unicode.rs.html#1169-1171' title='goto source code'>[src]</a></h4><h4 id='method.by_ref-2' class="method"><code id='by_ref.v-2'>fn <a href='../regex/trait.Replacer.html#method.by_ref' class='fnname'>by_ref</a><'r>(&'r mut self) -> <a class="struct" href="../regex/struct.ReplacerRef.html" title="struct regex::ReplacerRef">ReplacerRef</a><'r, Self></code><a class='srclink' href='../src/regex/re_unicode.rs.html#1154-1156' title='goto source code'>[src]</a></h4></div><h3 id='impl-Replacer-1' class='impl'><code class='in-band'>impl<'t> Replacer for <a class="struct" href="../regex/struct.NoExpand.html" title="struct regex::NoExpand">NoExpand</a><'t></code><a href='#impl-Replacer-1' class='anchor'></a><a class='srclink' href='../src/regex/re_unicode.rs.html#1203-1211' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.replace_append-2' class="method hidden"><code id='replace_append.v-3'>fn <a href='#method.replace_append-2' class='fnname'>replace_append</a>(&mut self, _: &<a class="struct" href="../regex/struct.Captures.html" title="struct regex::Captures">Captures</a>, dst: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code><a class='srclink' href='../src/regex/re_unicode.rs.html#1204-1206' title='goto source code'>[src]</a></h4><h4 id='method.no_expansion-3' class="method hidden"><code id='no_expansion.v-3'>fn <a href='#method.no_expansion-3' class='fnname'>no_expansion</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>></code><a class='srclink' href='../src/regex/re_unicode.rs.html#1208-1210' title='goto source code'>[src]</a></h4><h4 id='method.by_ref-3' class="method"><code id='by_ref.v-3'>fn <a href='../regex/trait.Replacer.html#method.by_ref' class='fnname'>by_ref</a><'r>(&'r mut self) -> <a class="struct" href="../regex/struct.ReplacerRef.html" title="struct regex::ReplacerRef">ReplacerRef</a><'r, Self></code><a class='srclink' href='../src/regex/re_unicode.rs.html#1154-1156' title='goto source code'>[src]</a></h4></div><h3 id='impl-Replacer-2' class='impl'><code class='in-band'>impl<F, T> Replacer for F <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="../regex/struct.Captures.html" title="struct regex::Captures">Captures</a>) -> T,<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>, </span></code><a href='#impl-Replacer-2' class='anchor'></a><a class='srclink' href='../src/regex/re_unicode.rs.html#1187-1191' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.replace_append-3' class="method hidden"><code id='replace_append.v-4'>fn <a href='#method.replace_append-3' class='fnname'>replace_append</a>(&mut self, caps: &<a class="struct" href="../regex/struct.Captures.html" title="struct regex::Captures">Captures</a>, dst: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code><a class='srclink' href='../src/regex/re_unicode.rs.html#1188-1190' title='goto source code'>[src]</a></h4><h4 id='method.no_expansion-4' class="method"><code id='no_expansion.v-4'>fn <a href='../regex/trait.Replacer.html#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="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'r, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>></code><a class='srclink' href='../src/regex/re_unicode.rs.html#1129-1131' title='goto source code'>[src]</a></h4><h4 id='method.by_ref-4' class="method"><code id='by_ref.v-4'>fn <a href='../regex/trait.Replacer.html#method.by_ref' class='fnname'>by_ref</a><'r>(&'r mut self) -> <a class="struct" href="../regex/struct.ReplacerRef.html" title="struct regex::ReplacerRef">ReplacerRef</a><'r, Self></code><a class='srclink' href='../src/regex/re_unicode.rs.html#1154-1156' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><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><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 = "regex";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |