<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="A configurable builder for a `RegexSet`."><title>RegexSetBuilder in regex::bytes - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../../static.files/rustdoc-5bc39a1768837dd0.css"><metaname="rustdoc-vars"data-root-path="../../"data-static-root-path="../../static.files/"data-current-crate="regex"data-themes=""data-resource-suffix=""data-rustdoc-version="1.77.1 (7cf61ebde 2024-03-27)"data-channel="1.77.1"data-search-js="search-dd67cee4cfa65049.js"data-settings-js="settings-4313503d2e1961c2.js"><scriptsrc="../../static.files/storage-4c98445ec4002617.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../../static.files/main-48f368f3872407c8.js"></script><noscript><linkrel="stylesheet"href="../../static.files/noscript-04d5337699b92874.css"></noscript><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle"title="show sidebar"></button></nav><navclass="sidebar"><divclass="sidebar-crate"><h2><ahref="../../regex/index.html">regex</a><spanclass="version">1.10.4</span></h2></div><h2class="location"><ahref="#">RegexSetBuilder</a></h2><divclass="sidebar-elems"><section><h3><ahref="#implementations">Methods</a></h3><ulclass="block method"><li><ahref="#method.build">build</a></li><li><ahref="#method.case_insensitive">case_insensitive</a></li><li><ahref="#method.crlf">crlf</a></li><li><ahref="#method.dfa_size_limit">dfa_size_limit</a></li><li><ahref="#method.dot_matches_new_line">dot_matches_new_line</a></li><li><ahref="#method.ignore_whitespace">ignore_whitespace</a></li><li><ahref="#method.line_terminator">line_terminator</a></li><li><ahref="#method.multi_line">multi_line</a></li><li><ahref="#method.nest_limit">nest_limit</a></li><li><ahref="#method.new">new</a></li><li><ahref="#method.octal">octal</a></li><li><ahref="#method.size_limit">size_limit</a></li><li><ahref="#method.swap_greed">swap_greed</a></li><li><ahref="#method.unicode">unicode</a></li></ul><h3><ahref="#trait-implementations">Trait Implementations</a></h3><ulclass="block trait-implementation"><li><ahref="#impl-Clone-for-RegexSetBuilder">Clone</a></li><li><ahref="#impl-Debug-for-RegexSetBuilder">Debug</a></li></ul><h3><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><ulclass="block synthetic-implementation"><li><ahref="#impl-RefUnwindSafe-for-RegexSetBuilder">RefUnwindSafe</a></li><li><ahref="#impl-Send-for-RegexSetBuilder">Send</a></li><li><ahref="#impl-Sync-for-RegexSetBuilder">Sync</a></li><li><ahref="#impl-Unpin-for-RegexSetBuilder">Unpin</a></li><li><ahref="#impl-UnwindSafe-for-RegexSetBuilder">UnwindSafe</a></li></ul><h3><ahref="#blanket-implementations">Blanket Implementations</a></
<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../../regex/all.html"title="show sidebar"></a></div><inputclass="search-input"name="search"aria-label="Run search in the documentation"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"tabindex="-1"><ahref="../../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Struct <ahref="../index.html">regex</a>::<wbr><ahref="index.html">bytes</a>::<wbr><aclass="struct"href="#">RegexSetBuilder</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../../src/regex/builders.rs.html#1966-1968">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub struct RegexSetBuilder { <spanclass="comment">/* private fields */</span> }</code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>A configurable builder for a <ahref="struct.RegexSet.html"title="struct regex::bytes::RegexSet"><code>RegexSet</code></a>.</p>
<p>This builder can be used to programmatically set flags such as <code>i</code>
(case insensitive) and <code>x</code> (for verbose mode). This builder can also be
used to configure things like the line terminator and a size limit on
S: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.AsRef.html"title="trait core::convert::AsRef">AsRef</a><<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.str.html">str</a>>,</div></h4></section></summary><divclass="docblock"><p>Create a new builder with a default configuration for the given
<p>If the patterns are invalid or exceed the configured size limits,
then an error will be returned when <ahref="struct.RegexSetBuilder.html#method.build"title="method regex::bytes::RegexSetBuilder::build"><code>RegexSetBuilder::build</code></a> is
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.build"class="method"><aclass="src rightside"href="../../src/regex/builders.rs.html#1990-1992">source</a><h4class="code-header">pub fn <ahref="#method.build"class="fn">build</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="struct"href="struct.RegexSet.html"title="struct regex::bytes::RegexSet">RegexSet</a>, <aclass="enum"href="../enum.Error.html"title="enum regex::Error">Error</a>></h4></section></summary><divclass="docblock"><p>Compiles the patterns given to <code>RegexSetBuilder::new</code> with the
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.unicode"class="method"><aclass="src rightside"href="../../src/regex/builders.rs.html#2063-2066">source</a><h4class="code-header">pub fn <ahref="#method.unicode"class="fn">unicode</a>(&mut self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) ->&mut <aclass="struct"href="struct.RegexSetBuilder.html"title="struct regex::bytes::RegexSetBuilder">RegexSetBuilder</a></h4></section></summary><divclass="docblock"><p>This configures Unicode mode for the all of the patterns.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.case_insensitive"class="method"><aclass="src rightside"href="../../src/regex/builders.rs.html#2092-2095">source</a><h4class="code-header">pub fn <ahref="#method.case_insensitive"class="fn">case_insensitive</a>(&mut self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) ->&mut <aclass="struct"href="struct.RegexSetBuilder.html"title="struct regex::bytes::RegexSetBuilder">RegexSetBuilder</a></h4></section></summary><divclass="docblock"><p>This configures whether to enable case insensitive matching for all
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.multi_line"class="method"><aclass="src rightside"href="../../src/regex/builders.rs.html#2131-2134">source</a><h4class="code-header">pub fn <ahref="#method.multi_line"class="fn">multi_line</a>(&mut self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) ->&mut <aclass="struct"href="struct.RegexSetBuilder.html"title="struct regex::bytes::RegexSetBuilder">RegexSetBuilder</a></h4></section></summary><divclass="docblock"><p>This configures multi-line mode for all of the patterns.</p>
<li>The <ahref="struct.RegexSetBuilder.html#method.crlf"title="method regex::bytes::RegexSetBuilder::crlf"><code>RegexSetBuilder::crlf</code></a> option changes the line terminator
to be either <code>\r</code> or <code>\n</code>, but never at the position between a <code>\r</code>
and <code>\n</code>.</li>
</ul>
<p>This setting can also be configured using the inline flag <code>m</code> in
the pattern.</p>
<p>The default for this is <code>false</code>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.crlf"class="method"><aclass="src rightside"href="../../src/regex/builders.rs.html#2218-2221">source</a><h4class="code-header">pub fn <ahref="#method.crlf"class="fn">crlf</a>(&mut self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) ->&mut <aclass="struct"href="struct.RegexSetBuilder.html"title="struct regex::bytes::RegexSetBuilder">RegexSetBuilder</a></h4></section></summary><divclass="docblock"><p>This configures CRLF mode for all of the patterns.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.line_terminator"class="method"><aclass="src rightside"href="../../src/regex/builders.rs.html#2292-2295">source</a><h4class="code-header">pub fn <ahref="#method.line_terminator"class="fn">line_terminator</a>(&mut self, byte: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.u8.html">u8</a>) ->&mut <aclass="struct"href="struct.RegexSetBuilder.html"title="struct regex::bytes::RegexSetBuilder">RegexSetBuilder</a></h4></section></summary><divclass="docblock"><p>Configures the line terminator to be used by the regex.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.swap_greed"class="method"><aclass="src rightside"href="../../src/regex/builders.rs.html#2313-2316">source</a><h4class="code-header">pub fn <ahref="#method.swap_greed"class="fn">swap_greed</a>(&mut self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) ->&mut <aclass="struct"href="struct.RegexSetBuilder.html"title="struct regex::bytes::RegexSetBuilder">RegexSetBuilder</a></h4></section></summary><divclass="docblock"><p>This configures swap-greed mode for all of the patterns.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.ignore_whitespace"class="method"><aclass="src rightside"href="../../src/regex/builders.rs.html#2365-2371">source</a><h4class="code-header">pub fn <ahref="#method.ignore_whitespace"class="fn">ignore_whitespace</a>(&mut self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) ->&mut <aclass="struct"href="struct.RegexSetBuilder.html"title="struct regex::bytes::RegexSetBuilder">RegexSetBuilder</a></h4></section></summary><divclass="docblock"><p>This configures verbose mode for all of the patterns.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.octal"class="method"><aclass="src rightside"href="../../src/regex/builders.rs.html#2403-2406">source</a><h4class="code-header">pub fn <ahref="#method.octal"class="fn">octal</a>(&mut self, yes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.bool.html">bool</a>) ->&mut <aclass="struct"href="struct.RegexSetBuilder.html"title="struct regex::bytes::RegexSetBuilder">RegexSetBuilder</a></h4></section></summary><divclass="docblock"><p>This configures octal mode for all of the patterns.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.dfa_size_limit"class="method"><aclass="src rightside"href="../../src/regex/builders.rs.html#2490-2496">source</a><h4class="code-header">pub fn <ahref="#method.dfa_size_limit"class="fn">dfa_size_limit</a>(&mut self, bytes: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.usize.html">usize</a>) ->&mut <aclass="struct"href="struct.RegexSetBuilder.html"title="struct regex::bytes::RegexSetBuilder">RegexSetBuilder</a></h4></section></summary><divclass="docblock"><p>Set the approximate capacity, in bytes, of the cache of transitions
<code><ahref="https://doc.rust-lang.org/1.77.1/core/convert/trait.From.html"title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-ToOwned-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/alloc/borrow.rs.html#83-85">source</a><ahref="#impl-ToOwned-for-T"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://doc.rust-lang.org/1.77.1/alloc/borrow/trait.ToOwned.html"title="trait alloc::borrow::ToOwned">ToOwned</a> for T<divclass="where">where
T: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Owned"class="associatedtype trait-impl"><ahref="#associatedtype.Owned"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.77.1/alloc/borrow/trait.ToOwned.html#associatedtype.Owned"class="associatedtype">Owned</a> = T</h4></section></summary><divclass='docblock'>The resulting type after obtaining ownership.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.to_owned"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/alloc/borrow.rs.html#88">source</a><ahref="#method.to_owned"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.1/alloc/borrow/trait.ToOwned.html#tymethod.to_owned"class="fn">to_owned</a>(&self) -> T</h4></section></summary><divclass='docblock'>Creates owned data from borrowed data, usually by cloning. <ahref="https://doc.rust-lang.org/1.77.1/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.clone_into"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/alloc/borrow.rs.html#92">source</a><ahref="#method.clone_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.1/alloc/borrow/trait.ToOwned.html#method.clone_into"class="fn">clone_into</a>(&self, target: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/std/primitive.reference.html">&mut T</a>)</h4></section></summary><divclass='docblock'>Uses borrowed data to replace owned data, usually by cloning. <ahref="https://doc.rust-lang.org/1.77.1/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryFrom%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#804-806">source</a><ahref="#impl-TryFrom%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T<divclass="where">where
U: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error-1"class="associatedtype trait-impl"><ahref="#associatedtype.Error-1"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></section></summary><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_from"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#811">source</a><ahref="#method.try_from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html#tymethod.try_from"class="fn">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'>Performs the conversion.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryInto%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#789-791">source</a><ahref="#impl-TryInto%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T<divclass="where">where
U: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error"class="associatedtype trait-impl"><ahref="#associatedtype.Error"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_into"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#796">source</a><ahref="#method.try_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryInto.html#tymethod.try_into"class="fn">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
