| <!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="Match multiple (possibly overlapping) regular expressions in a single scan."><meta name="keywords" content="rust, rustlang, rust-lang, RegexSet"><title>RegexSet in regex::bytes - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../regex/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../regex/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">RegexSet</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.empty">empty</a></li><li><a href="#method.is_empty">is_empty</a></li><li><a href="#method.is_match">is_match</a></li><li><a href="#method.len">len</a></li><li><a href="#method.matches">matches</a></li><li><a href="#method.new">new</a></li><li><a href="#method.patterns">patterns</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-RegexSet">Clone</a></li><li><a href="#impl-Debug-for-RegexSet">Debug</a></li><li><a href="#impl-Default-for-RegexSet">Default</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-RegexSet">RefUnwindSafe</a></li><li><a href="#impl-Send-for-RegexSet">Send</a></li><li><a href="#impl-Sync-for-RegexSet">Sync</a></li><li><a href="#impl-Unpin-for-RegexSet">Unpin</a></li><li><a href="#impl-UnwindSafe-for-RegexSet">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-RegexSet">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-RegexSet">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-RegexSet">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-RegexSet">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-RegexSet">Into<U></a></li><li><a href="#impl-ToOwned-for-RegexSet">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-RegexSet">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-RegexSet">TryInto<U></a></li></ul></section><h2><a href="index.html">In regex::bytes</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../index.html">regex</a>::<wbr><a href="index.html">bytes</a>::<wbr><a class="struct" href="#">RegexSet</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/regex/re_set.rs.html#491-518">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct RegexSet(_);</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Match multiple (possibly overlapping) regular expressions in a single scan.</p> |
| <p>A regex set corresponds to the union of two or more regular expressions. |
| That is, a regex set will match text where at least one of its |
| constituent regular expressions matches. A regex set as its formulated here |
| provides a touch more power: it will also report <em>which</em> regular |
| expressions in the set match. Indeed, this is the key difference between |
| regex sets and a single <code>Regex</code> with many alternates, since only one |
| alternate can match at a time.</p> |
| <p>For example, consider regular expressions to match email addresses and |
| domains: <code>[a-z]+@[a-z]+\.(com|org|net)</code> and <code>[a-z]+\.(com|org|net)</code>. If a |
| regex set is constructed from those regexes, then searching the text |
| <code>foo@example.com</code> will report both regexes as matching. Of course, one |
| could accomplish this by compiling each regex on its own and doing two |
| searches over the text. The key advantage of using a regex set is that it |
| will report the matching regexes using a <em>single pass through the text</em>. |
| If one has hundreds or thousands of regexes to match repeatedly (like a URL |
| router for a complex web application or a user agent matcher), then a regex |
| set can realize huge performance gains.</p> |
| <h2 id="example"><a href="#example">Example</a></h2> |
| <p>This shows how the above two regexes (for matching email addresses and |
| domains) might work:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>set = RegexSet::new(<span class="kw-2">&</span>[ |
| <span class="string">r"[a-z]+@[a-z]+\.(com|org|net)"</span>, |
| <span class="string">r"[a-z]+\.(com|org|net)"</span>, |
| ]).unwrap(); |
| |
| <span class="comment">// Ask whether any regexes in the set match. |
| </span><span class="macro">assert!</span>(set.is_match(<span class="string">b"foo@example.com"</span>)); |
| |
| <span class="comment">// Identify which regexes in the set match. |
| </span><span class="kw">let </span>matches: Vec<<span class="kw">_</span>> = set.matches(<span class="string">b"foo@example.com"</span>).into_iter().collect(); |
| <span class="macro">assert_eq!</span>(<span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">1</span>], matches); |
| |
| <span class="comment">// Try again, but with text that only matches one of the regexes. |
| </span><span class="kw">let </span>matches: Vec<<span class="kw">_</span>> = set.matches(<span class="string">b"example.com"</span>).into_iter().collect(); |
| <span class="macro">assert_eq!</span>(<span class="macro">vec!</span>[<span class="number">1</span>], matches); |
| |
| <span class="comment">// Try again, but with text that doesn't match any regex in the set. |
| </span><span class="kw">let </span>matches: Vec<<span class="kw">_</span>> = set.matches(<span class="string">b"example"</span>).into_iter().collect(); |
| <span class="macro">assert!</span>(matches.is_empty());</code></pre></div> |
| <p>Note that it would be possible to adapt the above example to using <code>Regex</code> |
| with an expression like:</p> |
| <div class="example-wrap"><pre class="language-text"><code>(?P<email>[a-z]+@(?P<email_domain>[a-z]+[.](com|org|net)))|(?P<domain>[a-z]+[.](com|org|net))</code></pre></div> |
| <p>After a match, one could then inspect the capture groups to figure out |
| which alternates matched. The problem is that it is hard to make this |
| approach scale when there are many regexes since the overlap between each |
| alternate isn’t always obvious to reason about.</p> |
| <h2 id="limitations"><a href="#limitations">Limitations</a></h2> |
| <p>Regex sets are limited to answering the following two questions:</p> |
| <ol> |
| <li>Does any regex in the set match?</li> |
| <li>If so, which regexes in the set match?</li> |
| </ol> |
| <p>As with the main <a href="../struct.Regex.html" title="crate::Regex"><code>Regex</code></a> type, it is cheaper to ask (1) |
| instead of (2) since the matching engines can stop after the first match |
| is found.</p> |
| <p>You cannot directly extract <a href="../struct.Match.html" title="crate::Match"><code>Match</code></a> or |
| <a href="../struct.Captures.html" title="crate::Captures"><code>Captures</code></a> objects from a regex set. If you need these |
| operations, the recommended approach is to compile each pattern in the set |
| independently and scan the exact same input a second time with those |
| independently compiled patterns:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>regex::{Regex, RegexSet}; |
| |
| <span class="kw">let </span>patterns = [<span class="string">"foo"</span>, <span class="string">"bar"</span>]; |
| <span class="comment">// Both patterns will match different ranges of this string. |
| </span><span class="kw">let </span>text = <span class="string">"barfoo"</span>; |
| |
| <span class="comment">// Compile a set matching any of our patterns. |
| </span><span class="kw">let </span>set = RegexSet::new(<span class="kw-2">&</span>patterns).unwrap(); |
| <span class="comment">// Compile each pattern independently. |
| </span><span class="kw">let </span>regexes: Vec<<span class="kw">_</span>> = set.patterns().iter() |
| .map(|pat| Regex::new(pat).unwrap()) |
| .collect(); |
| |
| <span class="comment">// Match against the whole set first and identify the individual |
| // matching patterns. |
| </span><span class="kw">let </span>matches: Vec<<span class="kw-2">&</span>str> = set.matches(text).into_iter() |
| <span class="comment">// Dereference the match index to get the corresponding |
| // compiled pattern. |
| </span>.map(|match_idx| <span class="kw-2">&</span>regexes[match_idx]) |
| <span class="comment">// To get match locations or any other info, we then have to search |
| // the exact same text again, using our separately-compiled pattern. |
| </span>.map(|pat| pat.find(text).unwrap().as_str()) |
| .collect(); |
| |
| <span class="comment">// Matches arrive in the order the constituent patterns were declared, |
| // not the order they appear in the input. |
| </span><span class="macro">assert_eq!</span>(<span class="macro">vec!</span>[<span class="string">"foo"</span>, <span class="string">"bar"</span>], matches);</code></pre></div> |
| <h2 id="performance"><a href="#performance">Performance</a></h2> |
| <p>A <code>RegexSet</code> has the same performance characteristics as <code>Regex</code>. Namely, |
| search takes <code>O(mn)</code> time, where <code>m</code> is proportional to the size of the |
| regex set and <code>n</code> is proportional to the length of the search text.</p> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-RegexSet" class="impl has-srclink"><a class="srclink rightside" href="../../src/regex/re_set.rs.html#491-518">source</a><a href="#impl-RegexSet" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.RegexSet.html" title="struct regex::bytes::RegexSet">RegexSet</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../../src/regex/re_set.rs.html#491-518">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a><I, S>(exprs: I) -> Result<<a class="struct" href="struct.RegexSet.html" title="struct regex::bytes::RegexSet">RegexSet</a>, <a class="enum" href="../enum.Error.html" title="enum regex::Error">Error</a>><span class="where fmt-newline">where<br> S: AsRef<str>,<br> I: IntoIterator<Item = S>,</span></h4></section></summary><div class="docblock"><p>Create a new regex set with the given regular expressions.</p> |
| <p>This takes an iterator of <code>S</code>, where <code>S</code> is something that can produce |
| a <code>&str</code>. If any of the strings in the iterator are not valid regular |
| expressions, then an error is returned.</p> |
| <h5 id="example-1"><a href="#example-1">Example</a></h5> |
| <p>Create a new regex set from an iterator of strings:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>set = RegexSet::new(<span class="kw-2">&</span>[<span class="string">r"\w+"</span>, <span class="string">r"\d+"</span>]).unwrap(); |
| <span class="macro">assert!</span>(set.is_match(<span class="string">"foo"</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.empty" class="method has-srclink"><a class="srclink rightside" href="../../src/regex/re_set.rs.html#491-518">source</a><h4 class="code-header">pub fn <a href="#method.empty" class="fnname">empty</a>() -> <a class="struct" href="struct.RegexSet.html" title="struct regex::bytes::RegexSet">RegexSet</a></h4></section></summary><div class="docblock"><p>Create a new empty regex set.</p> |
| <h5 id="example-2"><a href="#example-2">Example</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>set = RegexSet::empty(); |
| <span class="macro">assert!</span>(set.is_empty());</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_match" class="method has-srclink"><a class="srclink rightside" href="../../src/regex/re_set.rs.html#491-518">source</a><h4 class="code-header">pub fn <a href="#method.is_match" class="fnname">is_match</a>(&self, text: &[u8]) -> bool</h4></section></summary><div class="docblock"><p>Returns true if and only if one of the regexes in this set matches |
| the text given.</p> |
| <p>This method should be preferred if you only need to test whether any |
| of the regexes in the set should match, but don’t care about <em>which</em> |
| regexes matched. This is because the underlying matching engine will |
| quit immediately after seeing the first match instead of continuing to |
| find all matches.</p> |
| <p>Note that as with searches using <code>Regex</code>, the expression is unanchored |
| by default. That is, if the regex does not start with <code>^</code> or <code>\A</code>, or |
| end with <code>$</code> or <code>\z</code>, then it is permitted to match anywhere in the |
| text.</p> |
| <h5 id="example-3"><a href="#example-3">Example</a></h5> |
| <p>Tests whether a set matches some text:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>set = RegexSet::new(<span class="kw-2">&</span>[<span class="string">r"\w+"</span>, <span class="string">r"\d+"</span>]).unwrap(); |
| <span class="macro">assert!</span>(set.is_match(<span class="string">"foo"</span>)); |
| <span class="macro">assert!</span>(!set.is_match(<span class="string">"☃"</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.matches" class="method has-srclink"><a class="srclink rightside" href="../../src/regex/re_set.rs.html#491-518">source</a><h4 class="code-header">pub fn <a href="#method.matches" class="fnname">matches</a>(&self, text: &[u8]) -> <a class="struct" href="struct.SetMatches.html" title="struct regex::bytes::SetMatches">SetMatches</a></h4></section></summary><div class="docblock"><p>Returns the set of regular expressions that match in the given text.</p> |
| <p>The set returned contains the index of each regular expression that |
| matches in the given text. The index is in correspondence with the |
| order of regular expressions given to <code>RegexSet</code>’s constructor.</p> |
| <p>The set can also be used to iterate over the matched indices.</p> |
| <p>Note that as with searches using <code>Regex</code>, the expression is unanchored |
| by default. That is, if the regex does not start with <code>^</code> or <code>\A</code>, or |
| end with <code>$</code> or <code>\z</code>, then it is permitted to match anywhere in the |
| text.</p> |
| <h5 id="example-4"><a href="#example-4">Example</a></h5> |
| <p>Tests which regular expressions match the given text:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>set = RegexSet::new(<span class="kw-2">&</span>[ |
| <span class="string">r"\w+"</span>, |
| <span class="string">r"\d+"</span>, |
| <span class="string">r"\pL+"</span>, |
| <span class="string">r"foo"</span>, |
| <span class="string">r"bar"</span>, |
| <span class="string">r"barfoo"</span>, |
| <span class="string">r"foobar"</span>, |
| ]).unwrap(); |
| <span class="kw">let </span>matches: Vec<<span class="kw">_</span>> = set.matches(<span class="string">"foobar"</span>).into_iter().collect(); |
| <span class="macro">assert_eq!</span>(matches, <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">6</span>]); |
| |
| <span class="comment">// You can also test whether a particular regex matched: |
| </span><span class="kw">let </span>matches = set.matches(<span class="string">"foobar"</span>); |
| <span class="macro">assert!</span>(!matches.matched(<span class="number">5</span>)); |
| <span class="macro">assert!</span>(matches.matched(<span class="number">6</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.len" class="method has-srclink"><a class="srclink rightside" href="../../src/regex/re_set.rs.html#491-518">source</a><h4 class="code-header">pub fn <a href="#method.len" class="fnname">len</a>(&self) -> usize</h4></section></summary><div class="docblock"><p>Returns the total number of regular expressions in this set.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_empty" class="method has-srclink"><a class="srclink rightside" href="../../src/regex/re_set.rs.html#491-518">source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fnname">is_empty</a>(&self) -> bool</h4></section></summary><div class="docblock"><p>Returns <code>true</code> if this set contains no regular expressions.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.patterns" class="method has-srclink"><a class="srclink rightside" href="../../src/regex/re_set.rs.html#491-518">source</a><h4 class="code-header">pub fn <a href="#method.patterns" class="fnname">patterns</a>(&self) -> &[String]</h4></section></summary><div class="docblock"><p>Returns the patterns that this set will match on.</p> |
| <p>This function can be used to determine the pattern for a match. The |
| slice returned has exactly as many patterns givens to this regex set, |
| and the order of the slice is the same as the order of the patterns |
| provided to the set.</p> |
| <h5 id="example-5"><a href="#example-5">Example</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>set = RegexSet::new(<span class="kw-2">&</span>[ |
| <span class="string">r"\w+"</span>, |
| <span class="string">r"\d+"</span>, |
| <span class="string">r"\pL+"</span>, |
| <span class="string">r"foo"</span>, |
| <span class="string">r"bar"</span>, |
| <span class="string">r"barfoo"</span>, |
| <span class="string">r"foobar"</span>, |
| ]).unwrap(); |
| <span class="kw">let </span>matches: Vec<<span class="kw">_</span>> = set |
| .matches(<span class="string">"foobar"</span>) |
| .into_iter() |
| .map(|match_idx| <span class="kw-2">&</span>set.patterns()[match_idx]) |
| .collect(); |
| <span class="macro">assert_eq!</span>(matches, <span class="macro">vec!</span>[<span class="string">r"\w+"</span>, <span class="string">r"\pL+"</span>, <span class="string">r"foo"</span>, <span class="string">r"bar"</span>, <span class="string">r"foobar"</span>]);</code></pre></div> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-RegexSet" class="impl has-srclink"><a class="srclink rightside" href="../../src/regex/re_set.rs.html#491-518">source</a><a href="#impl-Clone-for-RegexSet" class="anchor"></a><h3 class="code-header">impl Clone for <a class="struct" href="struct.RegexSet.html" title="struct regex::bytes::RegexSet">RegexSet</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/regex/re_set.rs.html#491-518">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&self) -> <a class="struct" href="struct.RegexSet.html" title="struct regex::bytes::RegexSet">RegexSet</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-RegexSet" class="impl has-srclink"><a class="srclink rightside" href="../../src/regex/re_set.rs.html#491-518">source</a><a href="#impl-Debug-for-RegexSet" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.RegexSet.html" title="struct regex::bytes::RegexSet">RegexSet</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/regex/re_set.rs.html#491-518">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Default-for-RegexSet" class="impl has-srclink"><a class="srclink rightside" href="../../src/regex/re_set.rs.html#491-518">source</a><a href="#impl-Default-for-RegexSet" class="anchor"></a><h3 class="code-header">impl Default for <a class="struct" href="struct.RegexSet.html" title="struct regex::bytes::RegexSet">RegexSet</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/regex/re_set.rs.html#491-518">source</a><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a class="fnname">default</a>() -> Self</h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a>Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-RegexSet" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-RegexSet" class="anchor"></a><h3 class="code-header">impl RefUnwindSafe for <a class="struct" href="struct.RegexSet.html" title="struct regex::bytes::RegexSet">RegexSet</a></h3></section><section id="impl-Send-for-RegexSet" class="impl has-srclink"><a href="#impl-Send-for-RegexSet" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.RegexSet.html" title="struct regex::bytes::RegexSet">RegexSet</a></h3></section><section id="impl-Sync-for-RegexSet" class="impl has-srclink"><a href="#impl-Sync-for-RegexSet" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.RegexSet.html" title="struct regex::bytes::RegexSet">RegexSet</a></h3></section><section id="impl-Unpin-for-RegexSet" class="impl has-srclink"><a href="#impl-Unpin-for-RegexSet" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.RegexSet.html" title="struct regex::bytes::RegexSet">RegexSet</a></h3></section><section id="impl-UnwindSafe-for-RegexSet" class="impl has-srclink"><a href="#impl-UnwindSafe-for-RegexSet" class="anchor"></a><h3 class="code-header">impl UnwindSafe for <a class="struct" href="struct.RegexSet.html" title="struct regex::bytes::RegexSet">RegexSet</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-RegexSet" class="impl has-srclink"><a href="#impl-Any-for-RegexSet" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-RegexSet" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-RegexSet" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-RegexSet" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-RegexSet" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-RegexSet" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-RegexSet" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-RegexSet" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-RegexSet" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-RegexSet" class="impl has-srclink"><a href="#impl-ToOwned-for-RegexSet" class="anchor"></a><h3 class="code-header">impl<T> ToOwned for T<span class="where fmt-newline">where<br> T: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone_into</a>(&self, target: &mut T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-RegexSet" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-RegexSet" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-RegexSet" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-RegexSet" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="regex" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
