187 lines
17 KiB
HTML
187 lines
17 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::bytes::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>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</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>
|
|||
|
|
|
|||
|
|
<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.no_expansion">no_expansion</a><a href="#method.by_ref">by_ref</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Replacer">&'a [u8]</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>regex</a>::<wbr><a href='index.html'>bytes</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">
|
|||
|
|
<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'>Trait <a href='../index.html'>regex</a>::<wbr><a href='index.html'>bytes</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_bytes.rs.html#973-1018' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><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/bytes/struct.Captures.html" title="struct regex::bytes::Captures">Captures</a>, dst: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</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.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</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/bytes/struct.ReplacerRef.html" title="struct regex::bytes::ReplacerRef">ReplacerRef</a><'r, Self> { ... }
|
|||
|
|
}</pre></div><div class='docblock'><p>Replacer describes types that can be used to replace matches in a byte
|
|||
|
|
string.</p>
|
|||
|
|
<p>In general, users of this crate shouldn't need to implement this trait,
|
|||
|
|
since implementations are already provided for <code>&[u8]</code> and
|
|||
|
|
<code>FnMut(&Captures) -> Vec<u8></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'><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/bytes/struct.Captures.html" title="struct regex::bytes::Captures">Captures</a>, dst: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</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[0])</code>.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<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'><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="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.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>></code></span></h3><div class='docblock'><p>Return a fixed unchanging replacement byte 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'><span id='by_ref.v' class='invisible'><code>fn <a href='#method.by_ref' class='fnname'>by_ref</a><'r>(&'r mut self) -> <a class="struct" href="../../regex/bytes/struct.ReplacerRef.html" title="struct regex::bytes::ReplacerRef">ReplacerRef</a><'r, Self></code></span></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>
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">regex</span>::<span class="ident">bytes</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">u8</span>],
|
|||
|
|
<span class="kw-2">mut</span> <span class="ident">rep</span>: <span class="ident">R</span>,
|
|||
|
|
) <span class="op">-></span> <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></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>
|
|||
|
|
<h2 id='foreign-impls' class='small-section-header'>
|
|||
|
|
Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-Replacer' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a> <a class="trait" href="../../regex/bytes/trait.Replacer.html" title="trait regex::bytes::Replacer">Replacer</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><a href='#impl-Replacer' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/regex/re_bytes.rs.html#1035-1046' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><span class='docblock autohide'><div class='impl-items'><h4 id='method.replace_append' class="method"><span id='replace_append.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='#method.replace_append' class='fnname'>replace_append</a>(&mut self, caps: &<a class="struct" href="../../regex/bytes/struct.Captures.html" title="struct regex::bytes::Captures">Captures</a>, dst: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/regex/re_bytes.rs.html#1036-1038' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.no_expansion-1' class="method"><span id='no_expansion.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>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.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/regex/re_bytes.rs.html#1040-1045' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.by_ref-1' class="method"><span id='by_ref.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../regex/bytes/trait.Replacer.html#method.by_ref' class='fnname'>by_ref</a><'r>(&'r mut self) -> <a class="struct" href="../../regex/bytes/struct.ReplacerRef.html" title="struct regex::bytes::ReplacerRef">ReplacerRef</a><'r, Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/regex/re_bytes.rs.html#1015-1017' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4></div></span>
|
|||
|
|
<h2 id='implementors' class='small-section-header'>
|
|||
|
|
Implementors<a href='#implementors' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
<li><table class='table-display'><tbody><tr><td><code>impl<'a, R: <a class="trait" href="../../regex/bytes/trait.Replacer.html" title="trait regex::bytes::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/bytes/struct.ReplacerRef.html" title="struct regex::bytes::ReplacerRef">ReplacerRef</a><'a, R></code><td><div class='out-of-band'><a class='srclink' href='../../src/regex/re_bytes.rs.html#1026-1033' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
|||
|
|
<li><table class='table-display'><tbody><tr><td><code>impl<F> 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/bytes/struct.Captures.html" title="struct regex::bytes::Captures">Captures</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>, </span></code><td><div class='out-of-band'><a class='srclink' href='../../src/regex/re_bytes.rs.html#1048-1052' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
|||
|
|
<li><table class='table-display'><tbody><tr><td><code>impl<'t> Replacer for <a class="struct" href="../../regex/bytes/struct.NoExpand.html" title="struct regex::bytes::NoExpand">NoExpand</a><'t></code><td><div class='out-of-band'><a class='srclink' href='../../src/regex/re_bytes.rs.html#1064-1072' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
|||
|
|
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|||
|
|
src="../../implementors/regex/bytes/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>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../../";
|
|||
|
|
window.currentCrate = "regex";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../main.js"></script>
|
|||
|
|
<script defer src="../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|