| <!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="API documentation for the Rust `Automaton` trait in crate `aho_corasick`."> |
| <meta name="keywords" content="rust, rustlang, rust-lang, Automaton"> |
| |
| <title>aho_corasick::Automaton - Rust</title> |
| |
| <link rel="stylesheet" type="text/css" href="../normalize.css"> |
| <link rel="stylesheet" type="text/css" href="../rustdoc.css"> |
| <link rel="stylesheet" type="text/css" href="../main.css"> |
| |
| |
| |
| |
| </head> |
| <body class="rustdoc trait"> |
| <!--[if lte IE 8]> |
| <div class="warning"> |
| This old browser is unsupported and will most likely display funky |
| things. |
| </div> |
| <![endif]--> |
| |
| |
| |
| <nav class="sidebar"> |
| |
| <p class='location'>Trait Automaton</p><div class="block items"><ul><li><a href="#required-methods">Required Methods</a></li><li><a href="#provided-methods">Provided Methods</a></li><li><a href="#implementors">Implementors</a></li></ul></div><p class='location'><a href='index.html'>aho_corasick</a></p><script>window.sidebarCurrent = {name: 'Automaton', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script> |
| </nav> |
| |
| <nav class="sub"> |
| <form class="search-form js-only"> |
| <div class="search-container"> |
| <input class="search-input" name="search" |
| autocomplete="off" |
| placeholder="Click or press ‘S’ to search, ‘?’ for more options…" |
| type="search"> |
| </div> |
| </form> |
| </nav> |
| |
| <section id='main' class="content"> |
| <h1 class='fqn'><span class='in-band'>Trait <a href='index.html'>aho_corasick</a>::<wbr><a class="trait" href=''>Automaton</a></span><span class='out-of-band'><span id='render-detail'> |
| <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs"> |
| [<span class='inner'>−</span>] |
| </a> |
| </span><a class='srclink' href='../src/aho_corasick/autiter.rs.html#11-109' title='goto source code'>[src]</a></span></h1> |
| <pre class='rust trait'>pub trait Automaton<P> { |
| fn <a href='#tymethod.next_state' class='fnname'>next_state</a>(&self, si: <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>, b: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>; |
| <div class='item-spacer'></div> fn <a href='#tymethod.has_match' class='fnname'>has_match</a>(&self, si: <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>, outi: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>; |
| <div class='item-spacer'></div> fn <a href='#tymethod.get_match' class='fnname'>get_match</a>(&self, si: <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>, outi: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, texti: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../aho_corasick/struct.Match.html" title="struct aho_corasick::Match">Match</a>; |
| <div class='item-spacer'></div> fn <a href='#tymethod.start_bytes' class='fnname'>start_bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>; |
| <div class='item-spacer'></div> fn <a href='#tymethod.patterns' class='fnname'>patterns</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a>P<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>; |
| <div class='item-spacer'></div> fn <a href='#tymethod.pattern' class='fnname'>pattern</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> &P; |
| |
| fn <a href='#method.len' class='fnname'>len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a> { ... } |
| <div class='item-spacer'></div> fn <a href='#method.is_empty' class='fnname'>is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... } |
| <div class='item-spacer'></div> fn <a href='#method.find' class='fnname'>find</a><'a, 's, Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>>(<br> &'a self, <br> s: &'s Q<br> ) -> <a class="struct" href="../aho_corasick/struct.Matches.html" title="struct aho_corasick::Matches">Matches</a><'a, 's, P, Self><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>, |
| { ... } |
| <div class='item-spacer'></div> fn <a href='#method.find_overlapping' class='fnname'>find_overlapping</a><'a, 's, Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>>(<br> &'a self, <br> s: &'s Q<br> ) -> <a class="struct" href="../aho_corasick/struct.MatchesOverlapping.html" title="struct aho_corasick::MatchesOverlapping">MatchesOverlapping</a><'a, 's, P, Self><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>, |
| { ... } |
| <div class='item-spacer'></div> fn <a href='#method.stream_find' class='fnname'>stream_find</a><'a, R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>>(<br> &'a self, <br> rdr: R<br> ) -> <a class="struct" href="../aho_corasick/struct.StreamMatches.html" title="struct aho_corasick::StreamMatches">StreamMatches</a><'a, R, P, Self><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>, |
| { ... } |
| <div class='item-spacer'></div> fn <a href='#method.stream_find_overlapping' class='fnname'>stream_find_overlapping</a><'a, R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>>(<br> &'a self, <br> rdr: R<br> ) -> <a class="struct" href="../aho_corasick/struct.StreamMatchesOverlapping.html" title="struct aho_corasick::StreamMatchesOverlapping">StreamMatchesOverlapping</a><'a, R, P, Self><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>, |
| { ... } |
| }</pre><div class='docblock'><p>An abstraction over automatons and their corresponding iterators. |
| The type parameter <code>P</code> is the type of the pattern that was used to |
| construct this Automaton.</p> |
| </div> |
| <h2 id='required-methods'>Required Methods</h2> |
| <div class='methods'> |
| <h3 id='tymethod.next_state' class='method'><span id='next_state.v' class='invisible'><code>fn <a href='#tymethod.next_state' class='fnname'>next_state</a>(&self, si: <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>, b: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a></code></span></h3><div class='docblock'><p>Return the next state given the current state and next character.</p> |
| </div><h3 id='tymethod.has_match' class='method'><span id='has_match.v' class='invisible'><code>fn <a href='#tymethod.has_match' class='fnname'>has_match</a>(&self, si: <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>, outi: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h3><div class='docblock'><p>Return true if and only if the given state and current pattern index |
| indicate a match.</p> |
| </div><h3 id='tymethod.get_match' class='method'><span id='get_match.v' class='invisible'><code>fn <a href='#tymethod.get_match' class='fnname'>get_match</a>(&self, si: <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>, outi: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, texti: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../aho_corasick/struct.Match.html" title="struct aho_corasick::Match">Match</a></code></span></h3><div class='docblock'><p>Build a match given the current state, pattern index and input index.</p> |
| </div><h3 id='tymethod.start_bytes' class='method'><span id='start_bytes.v' class='invisible'><code>fn <a href='#tymethod.start_bytes' class='fnname'>start_bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span></h3><div class='docblock'><p>Return the set of bytes that have transitions in the root state.</p> |
| </div><h3 id='tymethod.patterns' class='method'><span id='patterns.v' class='invisible'><code>fn <a href='#tymethod.patterns' class='fnname'>patterns</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a>P<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span></h3><div class='docblock'><p>Returns all of the patterns matched by this automaton.</p> |
| |
| <p>The order of the patterns is the order in which they were added.</p> |
| </div><h3 id='tymethod.pattern' class='method'><span id='pattern.v' class='invisible'><code>fn <a href='#tymethod.pattern' class='fnname'>pattern</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> &P</code></span></h3><div class='docblock'><p>Returns the pattern indexed at <code>i</code>.</p> |
| |
| <p>The index corresponds to the position at which the pattern was added |
| to the automaton, starting at <code>0</code>.</p> |
| </div></div> |
| <h2 id='provided-methods'>Provided Methods</h2> |
| <div class='methods'> |
| <h3 id='method.len' class='method'><span id='len.v' class='invisible'><code>fn <a href='#method.len' class='fnname'>len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></h3><div class='docblock'><p>Return the number of patterns in the automaton.</p> |
| </div><h3 id='method.is_empty' class='method'><span id='is_empty.v' class='invisible'><code>fn <a href='#method.is_empty' class='fnname'>is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h3><div class='docblock'><p>Returns true if the automaton has no patterns.</p> |
| </div><h3 id='method.find' class='method'><span id='find.v' class='invisible'><code>fn <a href='#method.find' class='fnname'>find</a><'a, 's, Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>>(<br> &'a self, <br> s: &'s Q<br>) -> <a class="struct" href="../aho_corasick/struct.Matches.html" title="struct aho_corasick::Matches">Matches</a><'a, 's, P, Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></h3><div class='docblock'><p>Returns an iterator of non-overlapping matches in <code>s</code>.</p> |
| </div><h3 id='method.find_overlapping' class='method'><span id='find_overlapping.v' class='invisible'><code>fn <a href='#method.find_overlapping' class='fnname'>find_overlapping</a><'a, 's, Q: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>>(<br> &'a self, <br> s: &'s Q<br>) -> <a class="struct" href="../aho_corasick/struct.MatchesOverlapping.html" title="struct aho_corasick::MatchesOverlapping">MatchesOverlapping</a><'a, 's, P, Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></h3><div class='docblock'><p>Returns an iterator of overlapping matches in <code>s</code>.</p> |
| </div><h3 id='method.stream_find' class='method'><span id='stream_find.v' class='invisible'><code>fn <a href='#method.stream_find' class='fnname'>stream_find</a><'a, R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>>(&'a self, rdr: R) -> <a class="struct" href="../aho_corasick/struct.StreamMatches.html" title="struct aho_corasick::StreamMatches">StreamMatches</a><'a, R, P, Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></h3><div class='docblock'><p>Returns an iterator of non-overlapping matches in the given reader.</p> |
| </div><h3 id='method.stream_find_overlapping' class='method'><span id='stream_find_overlapping.v' class='invisible'><code>fn <a href='#method.stream_find_overlapping' class='fnname'>stream_find_overlapping</a><'a, R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>>(<br> &'a self, <br> rdr: R<br>) -> <a class="struct" href="../aho_corasick/struct.StreamMatchesOverlapping.html" title="struct aho_corasick::StreamMatchesOverlapping">StreamMatchesOverlapping</a><'a, R, P, Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></h3><div class='docblock'><p>Returns an iterator of overlapping matches in the given reader.</p> |
| </div></div> |
| <h2 id='implementors'>Implementors</h2> |
| <ul class='item-list' id='implementors-list'> |
| <li><code>impl<'a, P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, A: 'a + <a class="trait" href="../aho_corasick/trait.Automaton.html" title="trait aho_corasick::Automaton">Automaton</a><P> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> Automaton<P> for &'a A</code></li> |
| <li><code>impl<P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>> Automaton<P> for <a class="struct" href="../aho_corasick/struct.FullAcAutomaton.html" title="struct aho_corasick::FullAcAutomaton">FullAcAutomaton</a><P></code></li> |
| <li><code>impl<P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, T: <a class="trait" href="../aho_corasick/trait.Transitions.html" title="trait aho_corasick::Transitions">Transitions</a>> Automaton<P> for <a class="struct" href="../aho_corasick/struct.AcAutomaton.html" title="struct aho_corasick::AcAutomaton">AcAutomaton</a><P, T></code></li> |
| </ul><script type="text/javascript" async |
| src="../implementors/aho_corasick/trait.Automaton.js"> |
| </script></section> |
| <section id='search' class="content hidden"></section> |
| |
| <section class="footer"></section> |
| |
| <aside id="help" class="hidden"> |
| <div> |
| <h1 class="hidden">Help</h1> |
| |
| <div class="shortcuts"> |
| <h2>Keyboard Shortcuts</h2> |
| |
| <dl> |
| <dt>?</dt> |
| <dd>Show this help dialog</dd> |
| <dt>S</dt> |
| <dd>Focus the search field</dd> |
| <dt>⇤</dt> |
| <dd>Move up in search results</dd> |
| <dt>⇥</dt> |
| <dd>Move down in search results</dd> |
| <dt>⏎</dt> |
| <dd>Go to active search result</dd> |
| <dt>+</dt> |
| <dd>Collapse/expand all sections</dd> |
| </dl> |
| </div> |
| |
| <div class="infos"> |
| <h2>Search Tricks</h2> |
| |
| <p> |
| Prefix searches with a type followed by a colon (e.g. |
| <code>fn:</code>) to restrict the search to a given type. |
| </p> |
| |
| <p> |
| Accepted types are: <code>fn</code>, <code>mod</code>, |
| <code>struct</code>, <code>enum</code>, |
| <code>trait</code>, <code>type</code>, <code>macro</code>, |
| and <code>const</code>. |
| </p> |
| |
| <p> |
| Search functions by type signature (e.g. |
| <code>vec -> usize</code> or <code>* -> vec</code>) |
| </p> |
| </div> |
| </div> |
| </aside> |
| |
| |
| |
| <script> |
| window.rootPath = "../"; |
| window.currentCrate = "aho_corasick"; |
| </script> |
| <script src="../main.js"></script> |
| <script defer src="../search-index.js"></script> |
| </body> |
| </html> |