pnmixer-rust/aho_corasick/struct.FullAcAutomaton.html
2017-07-15 01:30:16 +02:00

157 lines
19 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `FullAcAutomaton` struct in crate `aho_corasick`.">
<meta name="keywords" content="rust, rustlang, rust-lang, FullAcAutomaton">
<title>aho_corasick::FullAcAutomaton - 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 struct">
<!--[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'>Struct FullAcAutomaton</p><div class="block items"><ul><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='index.html'>aho_corasick</a></p><script>window.sidebarCurrent = {name: 'FullAcAutomaton', ty: 'struct', 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'>Struct <a href='index.html'>aho_corasick</a>::<wbr><a class="struct" href=''>FullAcAutomaton</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/aho_corasick/full.rs.html#20-25' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct FullAcAutomaton&lt;P&gt; { /* fields omitted */ }</pre><div class='docblock'><p>A complete Aho-Corasick automaton.</p>
<p>This uses a single transition matrix that permits each input character
to move to the next state with a single lookup in the matrix.</p>
<p>This is as fast as it gets, but it is guaranteed to use a lot of memory.
Namely, it will use at least <code>4 * 256 * #states</code>, where the number of
states is capped at length of all patterns concatenated.</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl&lt;P:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;<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>&gt;&gt; <a class="struct" href="../aho_corasick/struct.FullAcAutomaton.html" title="struct aho_corasick::FullAcAutomaton">FullAcAutomaton</a>&lt;P&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/aho_corasick/full.rs.html#27-77' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>&lt;T:&nbsp;<a class="trait" href="../aho_corasick/trait.Transitions.html" title="trait aho_corasick::Transitions">Transitions</a>&gt;(ac: <a class="struct" href="../aho_corasick/struct.AcAutomaton.html" title="struct aho_corasick::AcAutomaton">AcAutomaton</a>&lt;P, T&gt;) -&gt; <a class="struct" href="../aho_corasick/struct.FullAcAutomaton.html" title="struct aho_corasick::FullAcAutomaton">FullAcAutomaton</a>&lt;P&gt;</code></span></h4>
<div class='docblock'><p>Build a new expanded Aho-Corasick automaton from an existing
Aho-Corasick automaton.</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl&lt;P:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../aho_corasick/struct.FullAcAutomaton.html" title="struct aho_corasick::FullAcAutomaton">FullAcAutomaton</a>&lt;P&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/aho_corasick/full.rs.html#19' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../aho_corasick/struct.FullAcAutomaton.html" title="struct aho_corasick::FullAcAutomaton">FullAcAutomaton</a>&lt;P&gt;</code></span></h4>
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: &amp;Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl&lt;P:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;<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>&gt;&gt; <a class="trait" href="../aho_corasick/trait.Automaton.html" title="trait aho_corasick::Automaton">Automaton</a>&lt;P&gt; for <a class="struct" href="../aho_corasick/struct.FullAcAutomaton.html" title="struct aho_corasick::FullAcAutomaton">FullAcAutomaton</a>&lt;P&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/aho_corasick/full.rs.html#79-117' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.next_state' class="method"><span id='next_state.v' class='invisible'><code>fn <a href='../aho_corasick/trait.Automaton.html#tymethod.next_state' class='fnname'>next_state</a>(&amp;self, si: <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -&gt; <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a></code></span></h4>
<div class='docblock'><p>Return the next state given the current state and next character.</p>
</div><h4 id='method.get_match' class="method"><span id='get_match.v' class='invisible'><code>fn <a href='../aho_corasick/trait.Automaton.html#tymethod.get_match' class='fnname'>get_match</a>(&amp;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>) -&gt; <a class="struct" href="../aho_corasick/struct.Match.html" title="struct aho_corasick::Match">Match</a></code></span></h4>
<div class='docblock'><p>Build a match given the current state, pattern index and input index.</p>
</div><h4 id='method.has_match' class="method"><span id='has_match.v' class='invisible'><code>fn <a href='../aho_corasick/trait.Automaton.html#tymethod.has_match' class='fnname'>has_match</a>(&amp;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>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4>
<div class='docblock'><p>Return true if and only if the given state and current pattern index indicate a match. <a href="../aho_corasick/trait.Automaton.html#tymethod.has_match">Read more</a></p>
</div><h4 id='method.start_bytes' class="method"><span id='start_bytes.v' class='invisible'><code>fn <a href='../aho_corasick/trait.Automaton.html#tymethod.start_bytes' class='fnname'>start_bytes</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</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></h4>
<div class='docblock'><p>Return the set of bytes that have transitions in the root state.</p>
</div><h4 id='method.patterns' class="method"><span id='patterns.v' class='invisible'><code>fn <a href='../aho_corasick/trait.Automaton.html#tymethod.patterns' class='fnname'>patterns</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a>P<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code></span></h4>
<div class='docblock'><p>Returns all of the patterns matched by this automaton. <a href="../aho_corasick/trait.Automaton.html#tymethod.patterns">Read more</a></p>
</div><h4 id='method.pattern' class="method"><span id='pattern.v' class='invisible'><code>fn <a href='../aho_corasick/trait.Automaton.html#tymethod.pattern' class='fnname'>pattern</a>(&amp;self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; &amp;P</code></span></h4>
<div class='docblock'><p>Returns the pattern indexed at <code>i</code>. <a href="../aho_corasick/trait.Automaton.html#tymethod.pattern">Read more</a></p>
</div><h4 id='method.len' class="method"><span id='len.v' class='invisible'><code>fn <a href='../aho_corasick/trait.Automaton.html#method.len' class='fnname'>len</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></h4>
<div class='docblock'><p>Return the number of patterns in the automaton.</p>
</div><h4 id='method.is_empty' class="method"><span id='is_empty.v' class='invisible'><code>fn <a href='../aho_corasick/trait.Automaton.html#method.is_empty' class='fnname'>is_empty</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></h4>
<div class='docblock'><p>Returns true if the automaton has no patterns.</p>
</div><h4 id='method.find' class="method"><span id='find.v' class='invisible'><code>fn <a href='../aho_corasick/trait.Automaton.html#method.find' class='fnname'>find</a>&lt;'a, 's, Q:&nbsp;?<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>&lt;<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>&gt;&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;'a self, <br>&nbsp;&nbsp;&nbsp;&nbsp;s: &amp;'s Q<br>) -&gt; <a class="struct" href="../aho_corasick/struct.Matches.html" title="struct aho_corasick::Matches">Matches</a>&lt;'a, 's, P, Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code></span></h4>
<div class='docblock'><p>Returns an iterator of non-overlapping matches in <code>s</code>.</p>
</div><h4 id='method.find_overlapping' class="method"><span id='find_overlapping.v' class='invisible'><code>fn <a href='../aho_corasick/trait.Automaton.html#method.find_overlapping' class='fnname'>find_overlapping</a>&lt;'a, 's, Q:&nbsp;?<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>&lt;<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>&gt;&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;'a self, <br>&nbsp;&nbsp;&nbsp;&nbsp;s: &amp;'s Q<br>) -&gt; <a class="struct" href="../aho_corasick/struct.MatchesOverlapping.html" title="struct aho_corasick::MatchesOverlapping">MatchesOverlapping</a>&lt;'a, 's, P, Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code></span></h4>
<div class='docblock'><p>Returns an iterator of overlapping matches in <code>s</code>.</p>
</div><h4 id='method.stream_find' class="method"><span id='stream_find.v' class='invisible'><code>fn <a href='../aho_corasick/trait.Automaton.html#method.stream_find' class='fnname'>stream_find</a>&lt;'a, R:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>&gt;(&amp;'a self, rdr: R) -&gt; <a class="struct" href="../aho_corasick/struct.StreamMatches.html" title="struct aho_corasick::StreamMatches">StreamMatches</a>&lt;'a, R, P, Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code></span></h4>
<div class='docblock'><p>Returns an iterator of non-overlapping matches in the given reader.</p>
</div><h4 id='method.stream_find_overlapping' class="method"><span id='stream_find_overlapping.v' class='invisible'><code>fn <a href='../aho_corasick/trait.Automaton.html#method.stream_find_overlapping' class='fnname'>stream_find_overlapping</a>&lt;'a, R:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;'a self, <br>&nbsp;&nbsp;&nbsp;&nbsp;rdr: R<br>) -&gt; <a class="struct" href="../aho_corasick/struct.StreamMatchesOverlapping.html" title="struct aho_corasick::StreamMatchesOverlapping">StreamMatchesOverlapping</a>&lt;'a, R, P, Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code></span></h4>
<div class='docblock'><p>Returns an iterator of overlapping matches in the given reader.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl&lt;P:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;<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>&gt; + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../aho_corasick/struct.FullAcAutomaton.html" title="struct aho_corasick::FullAcAutomaton">FullAcAutomaton</a>&lt;P&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/aho_corasick/full.rs.html#132-136' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div></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>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</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>