| <!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="A contiguous NFA implementation of Aho-Corasick."><meta name="keywords" content="rust, rustlang, rust-lang, NFA"><title>NFA in aho_corasick::nfa::contiguous - 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="../../../aho_corasick/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="../../../aho_corasick/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">NFA</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.builder">builder</a></li><li><a href="#method.new">new</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Automaton-for-NFA">Automaton</a></li><li><a href="#impl-Clone-for-NFA">Clone</a></li><li><a href="#impl-Debug-for-NFA">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-NFA">RefUnwindSafe</a></li><li><a href="#impl-Send-for-NFA">Send</a></li><li><a href="#impl-Sync-for-NFA">Sync</a></li><li><a href="#impl-Unpin-for-NFA">Unpin</a></li><li><a href="#impl-UnwindSafe-for-NFA">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-NFA">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-NFA">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-NFA">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-NFA">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-NFA">Into<U></a></li><li><a href="#impl-ToOwned-for-NFA">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-NFA">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-NFA">TryInto<U></a></li></ul></section><h2><a href="index.html">In aho_corasick::nfa::contiguous</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">aho_corasick</a>::<wbr><a href="../index.html">nfa</a>::<wbr><a href="index.html">contiguous</a>::<wbr><a class="struct" href="#">NFA</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/aho_corasick/nfa/contiguous.rs.html#91-120">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 NFA { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A contiguous NFA implementation of Aho-Corasick.</p> |
| <p>When possible, prefer using <a href="../../struct.AhoCorasick.html"><code>AhoCorasick</code></a> instead of |
| this type directly. Using an <code>NFA</code> directly is typically only necessary |
| when one needs access to the <a href="../../automaton/trait.Automaton.html" title="Automaton"><code>Automaton</code></a> trait implementation.</p> |
| <p>This NFA can only be built by first constructing a <a href="../noncontiguous/struct.NFA.html" title="noncontiguous::NFA"><code>noncontiguous::NFA</code></a>. |
| Both <a href="struct.NFA.html#method.new" title="NFA::new"><code>NFA::new</code></a> and <a href="struct.Builder.html#method.build" title="Builder::build"><code>Builder::build</code></a> do this for you automatically, but |
| <a href="struct.Builder.html#method.build_from_noncontiguous" title="Builder::build_from_noncontiguous"><code>Builder::build_from_noncontiguous</code></a> permits doing it explicitly.</p> |
| <p>The main difference between a noncontiguous NFA and a contiguous NFA is |
| that the latter represents all of its states and transitions in a single |
| allocation, where as the former uses a separate allocation for each state. |
| Doing this at construction time while keeping a low memory footprint isn’t |
| feasible, which is primarily why there are two different NFA types: one |
| that does the least amount of work possible to build itself, and another |
| that does a little extra work to compact itself and make state transitions |
| faster by making some states use a dense representation.</p> |
| <p>Because a contiguous NFA uses a single allocation, there is a lot more |
| opportunity for compression tricks to reduce the heap memory used. Indeed, |
| it is not uncommon for a contiguous NFA to use an order of magnitude less |
| heap memory than a noncontiguous NFA. Since building a contiguous NFA |
| usually only takes a fraction of the time it takes to build a noncontiguous |
| NFA, the overall build time is not much slower. Thus, in most cases, a |
| contiguous NFA is the best choice.</p> |
| <p>Since a contiguous NFA uses various tricks for compression and to achieve |
| faster state transitions, currently, its limit on the number of states |
| is somewhat smaller than what a noncontiguous NFA can achieve. Generally |
| speaking, you shouldn’t expect to run into this limit if the number of |
| patterns is under 1 million. It is plausible that this limit will be |
| increased in the future. If the limit is reached, building a contiguous NFA |
| will return an error. Often, since building a contiguous NFA is relatively |
| cheap, it can make sense to always try it even if you aren’t sure if it |
| will fail or not. If it does, you can always fall back to a noncontiguous |
| NFA. (Indeed, the main <a href="../../struct.AhoCorasick.html"><code>AhoCorasick</code></a> type employs a |
| strategy similar to this at construction time.)</p> |
| <h2 id="example"><a href="#example">Example</a></h2> |
| <p>This example shows how to build an <code>NFA</code> directly and use it to execute |
| <a href="../../automaton/trait.Automaton.html#method.try_find" title="Automaton::try_find"><code>Automaton::try_find</code></a>:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>aho_corasick::{ |
| automaton::Automaton, |
| nfa::contiguous::NFA, |
| Input, Match, |
| }; |
| |
| <span class="kw">let </span>patterns = <span class="kw-2">&</span>[<span class="string">"b"</span>, <span class="string">"abc"</span>, <span class="string">"abcd"</span>]; |
| <span class="kw">let </span>haystack = <span class="string">"abcd"</span>; |
| |
| <span class="kw">let </span>nfa = NFA::new(patterns).unwrap(); |
| <span class="macro">assert_eq!</span>( |
| <span class="prelude-val">Some</span>(Match::must(<span class="number">0</span>, <span class="number">1</span>..<span class="number">2</span>)), |
| nfa.try_find(<span class="kw-2">&</span>Input::new(haystack))<span class="question-mark">?</span>, |
| );</code></pre></div> |
| <p>It is also possible to implement your own version of <code>try_find</code>. See the |
| <a href="../../automaton/trait.Automaton.html" title="Automaton"><code>Automaton</code></a> documentation for an example.</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-NFA" class="impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#122-142">source</a><a href="#impl-NFA" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.NFA.html" title="struct aho_corasick::nfa::contiguous::NFA">NFA</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/aho_corasick/nfa/contiguous.rs.html#127-133">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a><I, P>(patterns: I) -> Result<<a class="struct" href="struct.NFA.html" title="struct aho_corasick::nfa::contiguous::NFA">NFA</a>, <a class="struct" href="../../struct.BuildError.html" title="struct aho_corasick::BuildError">BuildError</a>><span class="where fmt-newline">where<br> I: IntoIterator<Item = P>,<br> P: AsRef<[u8]>,</span></h4></section></summary><div class="docblock"><p>Create a new Aho-Corasick contiguous NFA using the default |
| configuration.</p> |
| <p>Use a <a href="struct.Builder.html" title="Builder"><code>Builder</code></a> if you want to change the configuration.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.builder" class="method has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#139-141">source</a><h4 class="code-header">pub fn <a href="#method.builder" class="fnname">builder</a>() -> <a class="struct" href="struct.Builder.html" title="struct aho_corasick::nfa::contiguous::Builder">Builder</a></h4></section></summary><div class="docblock"><p>A convenience method for returning a new Aho-Corasick contiguous NFA |
| builder.</p> |
| <p>This usually permits one to just import the <code>NFA</code> type.</p> |
| </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-Automaton-for-NFA" class="impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#176-322">source</a><a href="#impl-Automaton-for-NFA" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="../../automaton/trait.Automaton.html" title="trait aho_corasick::automaton::Automaton">Automaton</a> for <a class="struct" href="struct.NFA.html" title="struct aho_corasick::nfa::contiguous::NFA">NFA</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.start_state" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#178-183">source</a><a href="#method.start_state" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#tymethod.start_state" class="fnname">start_state</a>(&self, anchored: <a class="enum" href="../../enum.Anchored.html" title="enum aho_corasick::Anchored">Anchored</a>) -> Result<<a class="struct" href="../../automaton/struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>, <a class="struct" href="../../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>></h4></section></summary><div class='docblock'>Returns the starting state for the given anchor mode. <a href="../../automaton/trait.Automaton.html#tymethod.start_state">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.next_state" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#186-247">source</a><a href="#method.next_state" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#tymethod.next_state" class="fnname">next_state</a>(&self, anchored: <a class="enum" href="../../enum.Anchored.html" title="enum aho_corasick::Anchored">Anchored</a>, sid: <a class="struct" href="../../automaton/struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>, byte: u8) -> <a class="struct" href="../../automaton/struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a></h4></section></summary><div class='docblock'>Performs a state transition from <code>sid</code> for <code>byte</code> and returns the next |
| state. <a href="../../automaton/trait.Automaton.html#tymethod.next_state">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_special" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#250-252">source</a><a href="#method.is_special" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#tymethod.is_special" class="fnname">is_special</a>(&self, sid: <a class="struct" href="../../automaton/struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> bool</h4></section></summary><div class='docblock'>Returns true if the given ID represents a “special” state. A special |
| state is a dead, match or start state. <a href="../../automaton/trait.Automaton.html#tymethod.is_special">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_dead" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#255-257">source</a><a href="#method.is_dead" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#tymethod.is_dead" class="fnname">is_dead</a>(&self, sid: <a class="struct" href="../../automaton/struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> bool</h4></section></summary><div class='docblock'>Returns true if the given ID represents a dead state. <a href="../../automaton/trait.Automaton.html#tymethod.is_dead">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_match" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#260-262">source</a><a href="#method.is_match" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#tymethod.is_match" class="fnname">is_match</a>(&self, sid: <a class="struct" href="../../automaton/struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> bool</h4></section></summary><div class='docblock'>Returns true if the given ID represents a match state. <a href="../../automaton/trait.Automaton.html#tymethod.is_match">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_start" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#265-268">source</a><a href="#method.is_start" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#tymethod.is_start" class="fnname">is_start</a>(&self, sid: <a class="struct" href="../../automaton/struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> bool</h4></section></summary><div class='docblock'>Returns true if the given ID represents a start state. <a href="../../automaton/trait.Automaton.html#tymethod.is_start">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.match_kind" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#271-273">source</a><a href="#method.match_kind" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#tymethod.match_kind" class="fnname">match_kind</a>(&self) -> <a class="enum" href="../../enum.MatchKind.html" title="enum aho_corasick::MatchKind">MatchKind</a></h4></section></summary><div class='docblock'>Returns the match semantics that this automaton was built with.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.patterns_len" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#276-278">source</a><a href="#method.patterns_len" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#tymethod.patterns_len" class="fnname">patterns_len</a>(&self) -> usize</h4></section></summary><div class='docblock'>Returns the total number of patterns compiled into this automaton.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.pattern_len" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#281-283">source</a><a href="#method.pattern_len" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#tymethod.pattern_len" class="fnname">pattern_len</a>(&self, pid: <a class="struct" href="../../struct.PatternID.html" title="struct aho_corasick::PatternID">PatternID</a>) -> usize</h4></section></summary><div class='docblock'>Returns the length of the pattern for the given ID. <a href="../../automaton/trait.Automaton.html#tymethod.pattern_len">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.min_pattern_len" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#286-288">source</a><a href="#method.min_pattern_len" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#tymethod.min_pattern_len" class="fnname">min_pattern_len</a>(&self) -> usize</h4></section></summary><div class='docblock'>Returns the length, in bytes, of the shortest pattern in this |
| automaton. <a href="../../automaton/trait.Automaton.html#tymethod.min_pattern_len">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.max_pattern_len" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#291-293">source</a><a href="#method.max_pattern_len" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#tymethod.max_pattern_len" class="fnname">max_pattern_len</a>(&self) -> usize</h4></section></summary><div class='docblock'>Returns the length, in bytes, of the longest pattern in this automaton.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.match_len" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#296-298">source</a><a href="#method.match_len" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#tymethod.match_len" class="fnname">match_len</a>(&self, sid: <a class="struct" href="../../automaton/struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>) -> usize</h4></section></summary><div class='docblock'>Returns the total number of matches for the given state ID. <a href="../../automaton/trait.Automaton.html#tymethod.match_len">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.match_pattern" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#301-307">source</a><a href="#method.match_pattern" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#tymethod.match_pattern" class="fnname">match_pattern</a>(&self, sid: <a class="struct" href="../../automaton/struct.StateID.html" title="struct aho_corasick::automaton::StateID">StateID</a>, index: usize) -> <a class="struct" href="../../struct.PatternID.html" title="struct aho_corasick::PatternID">PatternID</a></h4></section></summary><div class='docblock'>Returns the pattern ID for the match state given by <code>sid</code> at the |
| <code>index</code> given. <a href="../../automaton/trait.Automaton.html#tymethod.match_pattern">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.memory_usage" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#310-316">source</a><a href="#method.memory_usage" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#tymethod.memory_usage" class="fnname">memory_usage</a>(&self) -> usize</h4></section></summary><div class='docblock'>Returns the heap memory usage, in bytes, used by this automaton.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.prefilter" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#319-321">source</a><a href="#method.prefilter" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#tymethod.prefilter" class="fnname">prefilter</a>(&self) -> Option<&<a class="struct" href="../../automaton/struct.Prefilter.html" title="struct aho_corasick::automaton::Prefilter">Prefilter</a>></h4></section></summary><div class='docblock'>Returns a prefilter, if available, that can be used to accelerate |
| searches for this automaton. <a href="../../automaton/trait.Automaton.html#tymethod.prefilter">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_find" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/automaton.rs.html#354-359">source</a><a href="#method.try_find" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#method.try_find" class="fnname">try_find</a>(&self, input: &<a class="struct" href="../../struct.Input.html" title="struct aho_corasick::Input">Input</a><'_>) -> Result<Option<<a class="struct" href="../../struct.Match.html" title="struct aho_corasick::Match">Match</a>>, <a class="struct" href="../../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>></h4></section></summary><div class='docblock'>Executes a non-overlapping search with this automaton using the given |
| configuration. <a href="../../automaton/trait.Automaton.html#method.try_find">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_find_overlapping" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/automaton.rs.html#367-373">source</a><a href="#method.try_find_overlapping" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#method.try_find_overlapping" class="fnname">try_find_overlapping</a>(<br> &self,<br> input: &<a class="struct" href="../../struct.Input.html" title="struct aho_corasick::Input">Input</a><'_>,<br> state: &mut <a class="struct" href="../../automaton/struct.OverlappingState.html" title="struct aho_corasick::automaton::OverlappingState">OverlappingState</a><br>) -> Result<(), <a class="struct" href="../../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>></h4></section></summary><div class='docblock'>Executes a overlapping search with this automaton using the given |
| configuration. <a href="../../automaton/trait.Automaton.html#method.try_find_overlapping">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_find_iter" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/automaton.rs.html#381-389">source</a><a href="#method.try_find_iter" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#method.try_find_iter" class="fnname">try_find_iter</a><'a, 'h>(<br> &'a self,<br> input: <a class="struct" href="../../struct.Input.html" title="struct aho_corasick::Input">Input</a><'h><br>) -> Result<<a class="struct" href="../../automaton/struct.FindIter.html" title="struct aho_corasick::automaton::FindIter">FindIter</a><'a, 'h, Self>, <a class="struct" href="../../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><span class="where fmt-newline">where<br> Self: Sized,</span></h4></section></summary><div class='docblock'>Returns an iterator of non-overlapping matches with this automaton |
| using the given configuration. <a href="../../automaton/trait.Automaton.html#method.try_find_iter">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_find_overlapping_iter" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/automaton.rs.html#397-423">source</a><a href="#method.try_find_overlapping_iter" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#method.try_find_overlapping_iter" class="fnname">try_find_overlapping_iter</a><'a, 'h>(<br> &'a self,<br> input: <a class="struct" href="../../struct.Input.html" title="struct aho_corasick::Input">Input</a><'h><br>) -> Result<<a class="struct" href="../../automaton/struct.FindOverlappingIter.html" title="struct aho_corasick::automaton::FindOverlappingIter">FindOverlappingIter</a><'a, 'h, Self>, <a class="struct" href="../../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><span class="where fmt-newline">where<br> Self: Sized,</span></h4></section></summary><div class='docblock'>Returns an iterator of overlapping matches with this automaton |
| using the given configuration. <a href="../../automaton/trait.Automaton.html#method.try_find_overlapping_iter">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_replace_all" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/automaton.rs.html#433-454">source</a><a href="#method.try_replace_all" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#method.try_replace_all" class="fnname">try_replace_all</a><B>(<br> &self,<br> haystack: &str,<br> replace_with: &[B]<br>) -> Result<String, <a class="struct" href="../../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><span class="where fmt-newline">where<br> Self: Sized,<br> B: AsRef<str>,</span></h4></section></summary><div class='docblock'>Replaces all non-overlapping matches in <code>haystack</code> with |
| strings from <code>replace_with</code> depending on the pattern that |
| matched. The <code>replace_with</code> slice must have length equal to |
| <code>Automaton::patterns_len</code>. <a href="../../automaton/trait.Automaton.html#method.try_replace_all">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_replace_all_bytes" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/automaton.rs.html#464-485">source</a><a href="#method.try_replace_all_bytes" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#method.try_replace_all_bytes" class="fnname">try_replace_all_bytes</a><B>(<br> &self,<br> haystack: &[u8],<br> replace_with: &[B]<br>) -> Result<Vec<u8>, <a class="struct" href="../../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><span class="where fmt-newline">where<br> Self: Sized,<br> B: AsRef<[u8]>,</span></h4></section></summary><div class='docblock'>Replaces all non-overlapping matches in <code>haystack</code> with |
| strings from <code>replace_with</code> depending on the pattern that |
| matched. The <code>replace_with</code> slice must have length equal to |
| <code>Automaton::patterns_len</code>. <a href="../../automaton/trait.Automaton.html#method.try_replace_all_bytes">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_replace_all_with" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/automaton.rs.html#493-522">source</a><a href="#method.try_replace_all_with" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#method.try_replace_all_with" class="fnname">try_replace_all_with</a><F>(<br> &self,<br> haystack: &str,<br> dst: &mut String,<br> replace_with: F<br>) -> Result<(), <a class="struct" href="../../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><span class="where fmt-newline">where<br> Self: Sized,<br> F: FnMut(&<a class="struct" href="../../struct.Match.html" title="struct aho_corasick::Match">Match</a>, &str, &mut String) -> bool,</span></h4></section></summary><div class='docblock'>Replaces all non-overlapping matches in <code>haystack</code> by calling the |
| <code>replace_with</code> closure given. <a href="../../automaton/trait.Automaton.html#method.try_replace_all_with">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_replace_all_with_bytes" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/automaton.rs.html#530-550">source</a><a href="#method.try_replace_all_with_bytes" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#method.try_replace_all_with_bytes" class="fnname">try_replace_all_with_bytes</a><F>(<br> &self,<br> haystack: &[u8],<br> dst: &mut Vec<u8>,<br> replace_with: F<br>) -> Result<(), <a class="struct" href="../../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><span class="where fmt-newline">where<br> Self: Sized,<br> F: FnMut(&<a class="struct" href="../../struct.Match.html" title="struct aho_corasick::Match">Match</a>, &[u8], &mut Vec<u8>) -> bool,</span></h4></section></summary><div class='docblock'>Replaces all non-overlapping matches in <code>haystack</code> by calling the |
| <code>replace_with</code> closure given. <a href="../../automaton/trait.Automaton.html#method.try_replace_all_with_bytes">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_stream_find_iter" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/automaton.rs.html#559-567">source</a><a href="#method.try_stream_find_iter" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#method.try_stream_find_iter" class="fnname">try_stream_find_iter</a><'a, R: Read>(<br> &'a self,<br> rdr: R<br>) -> Result<<a class="struct" href="../../automaton/struct.StreamFindIter.html" title="struct aho_corasick::automaton::StreamFindIter">StreamFindIter</a><'a, Self, R>, <a class="struct" href="../../struct.MatchError.html" title="struct aho_corasick::MatchError">MatchError</a>><span class="where fmt-newline">where<br> Self: Sized,</span></h4></section></summary><div class='docblock'>Returns an iterator of non-overlapping matches with this automaton |
| from the stream given. <a href="../../automaton/trait.Automaton.html#method.try_stream_find_iter">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_stream_replace_all" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/automaton.rs.html#578-599">source</a><a href="#method.try_stream_replace_all" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#method.try_stream_replace_all" class="fnname">try_stream_replace_all</a><R, W, B>(<br> &self,<br> rdr: R,<br> wtr: W,<br> replace_with: &[B]<br>) -> Result<()><span class="where fmt-newline">where<br> Self: Sized,<br> R: Read,<br> W: Write,<br> B: AsRef<[u8]>,</span></h4></section></summary><div class='docblock'>Replaces all non-overlapping matches in <code>rdr</code> with strings from |
| <code>replace_with</code> depending on the pattern that matched, and writes the |
| result to <code>wtr</code>. The <code>replace_with</code> slice must have length equal to |
| <code>Automaton::patterns_len</code>. <a href="../../automaton/trait.Automaton.html#method.try_stream_replace_all">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_stream_replace_all_with" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/automaton.rs.html#608-636">source</a><a href="#method.try_stream_replace_all_with" class="anchor"></a><h4 class="code-header">fn <a href="../../automaton/trait.Automaton.html#method.try_stream_replace_all_with" class="fnname">try_stream_replace_all_with</a><R, W, F>(<br> &self,<br> rdr: R,<br> wtr: W,<br> replace_with: F<br>) -> Result<()><span class="where fmt-newline">where<br> Self: Sized,<br> R: Read,<br> W: Write,<br> F: FnMut(&<a class="struct" href="../../struct.Match.html" title="struct aho_corasick::Match">Match</a>, &[u8], &mut W) -> Result<()>,</span></h4></section></summary><div class='docblock'>Replaces all non-overlapping matches in <code>rdr</code> by calling the |
| <code>replace_with</code> closure given and writing the result to <code>wtr</code>. <a href="../../automaton/trait.Automaton.html#method.try_stream_replace_all_with">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-NFA" class="impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#90">source</a><a href="#impl-Clone-for-NFA" class="anchor"></a><h3 class="code-header">impl Clone for <a class="struct" href="struct.NFA.html" title="struct aho_corasick::nfa::contiguous::NFA">NFA</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/aho_corasick/nfa/contiguous.rs.html#90">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.NFA.html" title="struct aho_corasick::nfa::contiguous::NFA">NFA</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-NFA" class="impl has-srclink"><a class="srclink rightside" href="../../../src/aho_corasick/nfa/contiguous.rs.html#324-380">source</a><a href="#impl-Debug-for-NFA" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.NFA.html" title="struct aho_corasick::nfa::contiguous::NFA">NFA</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/aho_corasick/nfa/contiguous.rs.html#325-379">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></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-NFA" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-NFA" class="anchor"></a><h3 class="code-header">impl RefUnwindSafe for <a class="struct" href="struct.NFA.html" title="struct aho_corasick::nfa::contiguous::NFA">NFA</a></h3></section><section id="impl-Send-for-NFA" class="impl has-srclink"><a href="#impl-Send-for-NFA" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.NFA.html" title="struct aho_corasick::nfa::contiguous::NFA">NFA</a></h3></section><section id="impl-Sync-for-NFA" class="impl has-srclink"><a href="#impl-Sync-for-NFA" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.NFA.html" title="struct aho_corasick::nfa::contiguous::NFA">NFA</a></h3></section><section id="impl-Unpin-for-NFA" class="impl has-srclink"><a href="#impl-Unpin-for-NFA" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.NFA.html" title="struct aho_corasick::nfa::contiguous::NFA">NFA</a></h3></section><section id="impl-UnwindSafe-for-NFA" class="impl has-srclink"><a href="#impl-UnwindSafe-for-NFA" class="anchor"></a><h3 class="code-header">impl UnwindSafe for <a class="struct" href="struct.NFA.html" title="struct aho_corasick::nfa::contiguous::NFA">NFA</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-NFA" class="impl has-srclink"><a href="#impl-Any-for-NFA" 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-NFA" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-NFA" 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-NFA" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-NFA" 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-NFA" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-NFA" 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-NFA" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-NFA" 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-NFA" class="impl has-srclink"><a href="#impl-ToOwned-for-NFA" 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-NFA" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-NFA" 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-NFA" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-NFA" 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="aho_corasick" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
