<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../../../regex_automata/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_automata</a>::<wbr><ahref="../index.html">hybrid</a>::<wbr><ahref="index.html">regex</a>::<wbr><aclass="struct"href="#">Cache</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_automata/hybrid/regex.rs.html#601-604">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub struct Cache { <spanclass="comment">/* private fields */</span> }</code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>A cache represents a partially computed forward and reverse DFA.</p>
<p>A cache is the key component that differentiates a classical DFA and a
hybrid NFA/DFA (also called a “lazy DFA”). Where a classical DFA builds a
complete transition table that can handle all possible inputs, a hybrid
NFA/DFA starts with an empty transition table and builds only the parts
required during search. The parts that are built are stored in a cache. For
this reason, a cache is a required parameter for nearly every operation on
a <ahref="struct.Regex.html"title="struct regex_automata::hybrid::regex::Regex"><code>Regex</code></a>.</p>
<p>Caches can be created from their corresponding <code>Regex</code> via
<ahref="struct.Regex.html#method.create_cache"title="method regex_automata::hybrid::regex::Regex::create_cache"><code>Regex::create_cache</code></a>. A cache can only be used with either the <code>Regex</code>
that created it, or the <code>Regex</code> that was most recently used to reset it
with <ahref="struct.Cache.html#method.reset"title="method regex_automata::hybrid::regex::Cache::reset"><code>Cache::reset</code></a>. Using a cache with any other <code>Regex</code> may result in
panics or incorrect results.</p>
</div></details><h2id="implementations"class="section-header">Implementations<ahref="#implementations"class="anchor">§</a></h2><divid="implementations-list"><detailsclass="toggle implementors-toggle"open><summary><sectionid="impl-Cache"class="impl"><aclass="src rightside"href="../../../src/regex_automata/hybrid/regex.rs.html#606-709">source</a><ahref="#impl-Cache"class="anchor">§</a><h3class="code-header">impl <aclass="struct"href="struct.Cache.html"title="struct regex_automata::hybrid::regex::Cache">Cache</a></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.new"class="method"><aclass="src rightside"href="../../../src/regex_automata/hybrid/regex.rs.html#612-616">source</a><h4class="code-header">pub fn <ahref="#method.new"class="fn">new</a>(re: &<aclass="struct"href="struct.Regex.html"title="struct regex_automata::hybrid::regex::Regex">Regex</a>) -><aclass="struct"href="struct.Cache.html"title="struct regex_automata::hybrid::regex::Cache">Cache</a></h4></section></summary><divclass="docblock"><p>Create a new cache for the given <code>Regex</code>.</p>
<p>The cache returned should only be used for searches for the given
<code>Regex</code>. If you want to reuse the cache for another <code>Regex</code>, then you
must call <ahref="struct.Cache.html#method.reset"title="method regex_automata::hybrid::regex::Cache::reset"><code>Cache::reset</code></a> with that <code>Regex</code>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.reset"class="method"><aclass="src rightside"href="../../../src/regex_automata/hybrid/regex.rs.html#659-662">source</a><h4class="code-header">pub fn <ahref="#method.reset"class="fn">reset</a>(&mut self, re: &<aclass="struct"href="struct.Regex.html"title="struct regex_automata::hybrid::regex::Regex">Regex</a>)</h4></section></summary><divclass="docblock"><p>Reset this cache such that it can be used for searching with the given
<code>Regex</code> (and only that <code>Regex</code>).</p>
<p>A cache reset permits reusing memory already allocated in this cache
with a different <code>Regex</code>.</p>
<p>Resetting a cache sets its “clear count” to 0. This is relevant if the
<code>Regex</code> has been configured to “give up” after it has cleared the cache
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.forward"class="method"><aclass="src rightside"href="../../../src/regex_automata/hybrid/regex.rs.html#665-667">source</a><h4class="code-header">pub fn <ahref="#method.forward"class="fn">forward</a>(&mut self) ->&<aclass="struct"href="../dfa/struct.Cache.html"title="struct regex_automata::hybrid::dfa::Cache">Cache</a></h4></section></summary><divclass="docblock"><p>Return a reference to the forward cache.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.reverse"class="method"><aclass="src rightside"href="../../../src/regex_automata/hybrid/regex.rs.html#670-672">source</a><h4class="code-header">pub fn <ahref="#method.reverse"class="fn">reverse</a>(&mut self) ->&<aclass="struct"href="../dfa/struct.Cache.html"title="struct regex_automata::hybrid::dfa::Cache">Cache</a></h4></section></summary><divclass="docblock"><p>Return a reference to the reverse cache.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.forward_mut"class="method"><aclass="src rightside"href="../../../src/regex_automata/hybrid/regex.rs.html#678-680">source</a><h4class="code-header">pub fn <ahref="#method.forward_mut"class="fn">forward_mut</a>(&mut self) ->&mut <aclass="struct"href="../dfa/struct.Cache.html"title="struct regex_automata::hybrid::dfa::Cache">Cache</a></h4></section></summary><divclass="docblock"><p>Return a mutable reference to the forward cache.</p>
<p>If you need mutable references to both the forward and reverse caches,
then use <ahref="struct.Cache.html#method.as_parts_mut"title="method regex_automata::hybrid::regex::Cache::as_parts_mut"><code>Cache::as_parts_mut</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.reverse_mut"class="method"><aclass="src rightside"href="../../../src/regex_automata/hybrid/regex.rs.html#686-688">source</a><h4class="code-header">pub fn <ahref="#method.reverse_mut"class="fn">reverse_mut</a>(&mut self) ->&mut <aclass="struct"href="../dfa/struct.Cache.html"title="struct regex_automata::hybrid::dfa::Cache">Cache</a></h4></section></summary><divclass="docblock"><p>Return a mutable reference to the reverse cache.</p>
<p>If you need mutable references to both the forward and reverse caches,
then use <ahref="struct.Cache.html#method.as_parts_mut"title="method regex_automata::hybrid::regex::Cache::as_parts_mut"><code>Cache::as_parts_mut</code></a>.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.as_parts"class="method"><aclass="src rightside"href="../../../src/regex_automata/hybrid/regex.rs.html#691-693">source</a><h4class="code-header">pub fn <ahref="#method.as_parts"class="fn">as_parts</a>(&self) -> (&<aclass="struct"href="../dfa/struct.Cache.html"title="struct regex_automata::hybrid::dfa::Cache">Cache</a>, &<aclass="struct"href="../dfa/struct.Cache.html"title="struct regex_automata::hybrid::dfa::Cache">Cache</a>)</h4></section></summary><divclass="docblock"><p>Return references to the forward and reverse caches, respectively.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.as_parts_mut"class="method"><aclass="src rightside"href="../../../src/regex_automata/hybrid/regex.rs.html#697-699">source</a><h4class="code-header">pub fn <ahref="#method.as_parts_mut"class="fn">as_parts_mut</a>(&mut self) -> (&mut <aclass="struct"href="../dfa/struct.Cache.html"title="struct regex_automata::hybrid::dfa::Cache">Cache</a>, &mut <aclass="struct"href="../dfa/struct.Cache.html"title="struct regex_automata::hybrid::dfa::Cache">Cache</a>)</h4></section></summary><divclass="docblock"><p>Return mutable references to the forward and reverse caches,
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.memory_usage"class="method"><aclass="src rightside"href="../../../src/regex_automata/hybrid/regex.rs.html#706-708">source</a><h4class="code-header">pub fn <ahref="#method.memory_usage"class="fn">memory_usage</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/1.78.0/std/primitive.usize.html">usize</a></h4></section></summary><divclass="docblock"><p>Returns the heap memory usage, in bytes, as a sum of the forward and
<code><ahref="https://doc.rust-lang.org/1.78.0/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.78.0/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.78.0/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.78.0/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.78.0/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.78.0/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.78.0/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.78.0/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.78.0/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.78.0/alloc/borrow/trait.ToOwned.html#method.clone_into"class="fn">clone_into</a>(&self, target: <aclass="primitive"href="https://doc.rust-lang.org/1.78.0/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.78.0/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.78.0/src/core/convert/mod.rs.html#805-807">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.78.0/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.78.0/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.78.0/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.78.0/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.78.0/src/core/convert/mod.rs.html#812">source</a><ahref="#method.try_from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html#tymethod.try_from"class="fn">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.78.0/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.78.0/src/core/convert/mod.rs.html#790-792">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.78.0/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.78.0/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.78.0/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.78.0/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.78.0/src/core/convert/mod.rs.html#797">source</a><ahref="#method.try_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryInto.html#tymethod.try_into"class="fn">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/1.78.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.78.0/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>
