39 lines
6.4 KiB
HTML
39 lines
6.4 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="Accepts a replacement string and interpolates capture references with their corresponding values."><title>string in regex_automata::util::interpolate - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="regex_automata" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">string</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../regex_automata/index.html">regex_<wbr>automata</a><span class="version">0.4.14</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">string</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In regex_<wbr>automata::<wbr>util::<wbr>interpolate</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">regex_automata</a>::<wbr><a href="../index.html">util</a>::<wbr><a href="index.html">interpolate</a></div><h1>Function <span class="fn">string</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/regex_automata/util/interpolate.rs.html#94-134">Source</a> </span></div><pre class="rust item-decl"><code>pub fn string(
|
||
replacement: &<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.str.html">str</a>,
|
||
append: impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>, &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>),
|
||
name_to_index: impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>>,
|
||
dst: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
|
||
)</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Accepts a replacement string and interpolates capture references with their
|
||
corresponding values.</p>
|
||
<p><code>append</code> should be a function that appends the string value of a capture
|
||
group at a particular index to the string given. If the capture group
|
||
index is invalid, then nothing should be appended.</p>
|
||
<p><code>name_to_index</code> should be a function that maps a capture group name to a
|
||
capture group index. If the given name doesn’t exist, then <code>None</code> should
|
||
be returned.</p>
|
||
<p>Finally, <code>dst</code> is where the final interpolated contents should be written.
|
||
If <code>replacement</code> contains no capture group references, then <code>dst</code> will be
|
||
equivalent to <code>replacement</code>.</p>
|
||
<p>See the <a href="index.html" title="mod regex_automata::util::interpolate">module documentation</a> for details about the format
|
||
supported.</p>
|
||
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>regex_automata::util::interpolate;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>dst = String::new();
|
||
interpolate::string(
|
||
<span class="string">"foo $bar baz"</span>,
|
||
|index, dst| {
|
||
<span class="kw">if </span>index == <span class="number">0 </span>{
|
||
dst.push_str(<span class="string">"BAR"</span>);
|
||
}
|
||
},
|
||
|name| {
|
||
<span class="kw">if </span>name == <span class="string">"bar" </span>{
|
||
<span class="prelude-val">Some</span>(<span class="number">0</span>)
|
||
} <span class="kw">else </span>{
|
||
<span class="prelude-val">None
|
||
</span>}
|
||
},
|
||
<span class="kw-2">&mut </span>dst,
|
||
);
|
||
<span class="macro">assert_eq!</span>(<span class="string">"foo BAR baz"</span>, dst);</code></pre></div></div></details></section></div></main></body></html> |