blob: 23b23dc443a1d248aaf6514955e9d3e3c5508c95 [file] [log] [blame]
<!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 `Transitions` trait in crate `aho_corasick`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Transitions">
<title>aho_corasick::Transitions - 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 Transitions</p><div class="block items"><ul><li><a href="#required-methods">Required 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: 'Transitions', 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=''>Transitions</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/lib.rs.html#410-419' title='goto source code'>[src]</a></span></h1>
<pre class='rust trait'>pub trait Transitions {
fn <a href='#tymethod.new' class='fnname'>new</a>(depth: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; Self;
<div class='item-spacer'></div> fn <a href='#tymethod.goto' class='fnname'>goto</a>(&amp;self, alpha: <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>;
<div class='item-spacer'></div> fn <a href='#tymethod.set_goto' class='fnname'>set_goto</a>(&amp;mut self, alpha: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, si: <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.heap_bytes' class='fnname'>heap_bytes</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
}</pre><div class='docblock'><p>An abstraction over state transition strategies.</p>
<p>This is an attempt to let the caller choose the space/time trade offs
used for state transitions.</p>
<p>(It&#39;s possible that this interface is merely good enough for just the two
implementations in this crate.)</p>
</div>
<h2 id='required-methods'>Required Methods</h2>
<div class='methods'>
<h3 id='tymethod.new' class='method'><span id='new.v' class='invisible'><code>fn <a href='#tymethod.new' class='fnname'>new</a>(depth: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; Self</code></span></h3><div class='docblock'><p>Return a new state at the given depth.</p>
</div><h3 id='tymethod.goto' class='method'><span id='goto.v' class='invisible'><code>fn <a href='#tymethod.goto' class='fnname'>goto</a>(&amp;self, alpha: <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></h3><div class='docblock'><p>Return the next state index given the next character.</p>
</div><h3 id='tymethod.set_goto' class='method'><span id='set_goto.v' class='invisible'><code>fn <a href='#tymethod.set_goto' class='fnname'>set_goto</a>(&amp;mut self, alpha: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, si: <a class="type" href="../aho_corasick/type.StateIdx.html" title="type aho_corasick::StateIdx">StateIdx</a>)</code></span></h3><div class='docblock'><p>Set the next state index for the character given.</p>
</div><h3 id='tymethod.heap_bytes' class='method'><span id='heap_bytes.v' class='invisible'><code>fn <a href='#tymethod.heap_bytes' class='fnname'>heap_bytes</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></h3><div class='docblock'><p>The memory use in bytes (on the heap) of this set of transitions.</p>
</div></div>
<h2 id='implementors'>Implementors</h2>
<ul class='item-list' id='implementors-list'>
<li><code>impl Transitions for <a class="struct" href="../aho_corasick/struct.Dense.html" title="struct aho_corasick::Dense">Dense</a></code></li>
<li><code>impl Transitions for <a class="struct" href="../aho_corasick/struct.Sparse.html" title="struct aho_corasick::Sparse">Sparse</a></code></li>
</ul><script type="text/javascript" async
src="../implementors/aho_corasick/trait.Transitions.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>&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>