43 lines
18 KiB
HTML
43 lines
18 KiB
HTML
<!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 `StateID` trait in crate `aho_corasick`."><meta name="keywords" content="rust, rustlang, rust-lang, StateID"><title>aho_corasick::StateID - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></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"><div class="sidebar-menu">☰</div><a href='../aho_corasick/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait StateID</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.from_usize">from_usize</a><a href="#tymethod.max_id">max_id</a><a href="#tymethod.to_usize">to_usize</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-StateID-for-u16">u16</a><a href="#impl-StateID-for-u32">u32</a><a href="#impl-StateID-for-u64">u64</a><a href="#impl-StateID-for-u8">u8</a><a href="#impl-StateID-for-usize">usize</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>aho_corasick</a></p><script>window.sidebarCurrent = {name: 'StateID', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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/state_id.rs.html#83-109' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>aho_corasick</a>::<wbr><a class="trait" href=''>StateID</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait StateID: Sealed + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a> {
|
||
fn <a href='#tymethod.from_usize' class='fnname'>from_usize</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.to_usize' class='fnname'>to_usize</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='#tymethod.max_id' class='fnname'>max_id</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
||
}</pre></div><div class='docblock'><p>A trait describing the representation of an automaton's state identifier.</p>
|
||
<p>The purpose of this trait is to safely express both the possible state
|
||
identifier representations that can be used in an automaton and to convert
|
||
between state identifier representations and types that can be used to
|
||
efficiently index memory (such as <code>usize</code>).</p>
|
||
<p>In general, one should not need to implement this trait explicitly. Indeed,
|
||
for now, this trait is sealed such that it cannot be implemented by any
|
||
other type. In particular, this crate provides implementations for <code>u8</code>,
|
||
<code>u16</code>, <code>u32</code>, <code>u64</code> and <code>usize</code>. (<code>u32</code> and <code>u64</code> are only provided for
|
||
targets that can represent all corresponding values in a <code>usize</code>.)</p>
|
||
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
||
<p>This trait is unsafe because the correctness of its implementations may be
|
||
relied upon by other unsafe code. For example, one possible way to
|
||
implement this trait incorrectly would be to return a maximum identifier
|
||
in <code>max_id</code> that is greater than the real maximum identifier. This will
|
||
likely result in wrap-on-overflow semantics in release mode, which can in
|
||
turn produce incorrect state identifiers. Those state identifiers may then
|
||
in turn access out-of-bounds memory in an automaton's search routine, where
|
||
bounds checks are explicitly elided for performance reasons.</p>
|
||
</div>
|
||
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.from_usize' class='method'><code id='from_usize.v'>fn <a href='#tymethod.from_usize' class='fnname'>from_usize</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code></h3><div class='docblock'><p>Convert from a <code>usize</code> to this implementation's representation.</p>
|
||
<p>Implementors may assume that <code>n <= Self::max_id</code>. That is, implementors
|
||
do not need to check whether <code>n</code> can fit inside this implementation's
|
||
representation.</p>
|
||
</div><h3 id='tymethod.to_usize' class='method'><code id='to_usize.v'>fn <a href='#tymethod.to_usize' class='fnname'>to_usize</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></h3><div class='docblock'><p>Convert this implementation's representation to a <code>usize</code>.</p>
|
||
<p>Implementors must not return a <code>usize</code> value greater than
|
||
<code>Self::max_id</code> and must not permit overflow when converting between the
|
||
implementor's representation and <code>usize</code>. In general, the preferred
|
||
way for implementors to achieve this is to simply not provide
|
||
implementations of <code>StateID</code> that cannot fit into the target platform's
|
||
<code>usize</code>.</p>
|
||
</div><h3 id='tymethod.max_id' class='method'><code id='max_id.v'>fn <a href='#tymethod.max_id' class='fnname'>max_id</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></h3><div class='docblock'><p>Return the maximum state identifier supported by this representation.</p>
|
||
<p>Implementors must return a correct bound. Doing otherwise may result
|
||
in memory unsafety.</p>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-StateID-for-usize' class='impl'><code class='in-band'>impl <a class="trait" href="../aho_corasick/trait.StateID.html" title="trait aho_corasick::StateID">StateID</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a href='#impl-StateID-for-usize' class='anchor'></a><a class='srclink' href='../src/aho_corasick/state_id.rs.html#111-120' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from_usize' class="method hidden"><code id='from_usize.v-1'>fn <a href='#method.from_usize' class='fnname'>from_usize</a>(n: <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.usize.html">usize</a></code><a class='srclink' href='../src/aho_corasick/state_id.rs.html#113' title='goto source code'>[src]</a></h4><h4 id='method.to_usize' class="method hidden"><code id='to_usize.v-1'>fn <a href='#method.to_usize' class='fnname'>to_usize</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/aho_corasick/state_id.rs.html#116' title='goto source code'>[src]</a></h4><h4 id='method.max_id' class="method hidden"><code id='max_id.v-1'>fn <a href='#method.max_id' class='fnname'>max_id</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/aho_corasick/state_id.rs.html#119' title='goto source code'>[src]</a></h4></div><h3 id='impl-StateID-for-u8' class='impl'><code class='in-band'>impl <a class="trait" href="../aho_corasick/trait.StateID.html" title="trait aho_corasick::StateID">StateID</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code><a href='#impl-StateID-for-u8' class='anchor'></a><a class='srclink' href='../src/aho_corasick/state_id.rs.html#122-131' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from_usize-1' class="method hidden"><code id='from_usize.v-2'>fn <a href='#method.from_usize' class='fnname'>from_usize</a>(n: <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.u8.html">u8</a></code><a class='srclink' href='../src/aho_corasick/state_id.rs.html#124' title='goto source code'>[src]</a></h4><h4 id='method.to_usize-1' class="method hidden"><code id='to_usize.v-2'>fn <a href='#method.to_usize' class='fnname'>to_usize</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/aho_corasick/state_id.rs.html#127' title='goto source code'>[src]</a></h4><h4 id='method.max_id-1' class="method hidden"><code id='max_id.v-2'>fn <a href='#method.max_id' class='fnname'>max_id</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/aho_corasick/state_id.rs.html#130' title='goto source code'>[src]</a></h4></div><h3 id='impl-StateID-for-u16' class='impl'><code class='in-band'>impl <a class="trait" href="../aho_corasick/trait.StateID.html" title="trait aho_corasick::StateID">StateID</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code><a href='#impl-StateID-for-u16' class='anchor'></a><a class='srclink' href='../src/aho_corasick/state_id.rs.html#133-142' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from_usize-2' class="method hidden"><code id='from_usize.v-3'>fn <a href='#method.from_usize' class='fnname'>from_usize</a>(n: <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.u16.html">u16</a></code><a class='srclink' href='../src/aho_corasick/state_id.rs.html#135' title='goto source code'>[src]</a></h4><h4 id='method.to_usize-2' class="method hidden"><code id='to_usize.v-3'>fn <a href='#method.to_usize' class='fnname'>to_usize</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/aho_corasick/state_id.rs.html#138' title='goto source code'>[src]</a></h4><h4 id='method.max_id-2' class="method hidden"><code id='max_id.v-3'>fn <a href='#method.max_id' class='fnname'>max_id</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/aho_corasick/state_id.rs.html#141' title='goto source code'>[src]</a></h4></div><h3 id='impl-StateID-for-u32' class='impl'><code class='in-band'>impl <a class="trait" href="../aho_corasick/trait.StateID.html" title="trait aho_corasick::StateID">StateID</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a href='#impl-StateID-for-u32' class='anchor'></a><a class='srclink' href='../src/aho_corasick/state_id.rs.html#145-154' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from_usize-3' class="method hidden"><code id='from_usize.v-4'>fn <a href='#method.from_usize' class='fnname'>from_usize</a>(n: <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.u32.html">u32</a></code><a class='srclink' href='../src/aho_corasick/state_id.rs.html#147' title='goto source code'>[src]</a></h4><h4 id='method.to_usize-3' class="method hidden"><code id='to_usize.v-4'>fn <a href='#method.to_usize' class='fnname'>to_usize</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/aho_corasick/state_id.rs.html#150' title='goto source code'>[src]</a></h4><h4 id='method.max_id-3' class="method hidden"><code id='max_id.v-4'>fn <a href='#method.max_id' class='fnname'>max_id</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/aho_corasick/state_id.rs.html#153' title='goto source code'>[src]</a></h4></div><h3 id='impl-StateID-for-u64' class='impl'><code class='in-band'>impl <a class="trait" href="../aho_corasick/trait.StateID.html" title="trait aho_corasick::StateID">StateID</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code><a href='#impl-StateID-for-u64' class='anchor'></a><a class='srclink' href='../src/aho_corasick/state_id.rs.html#157-166' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from_usize-4' class="method hidden"><code id='from_usize.v-5'>fn <a href='#method.from_usize' class='fnname'>from_usize</a>(n: <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.u64.html">u64</a></code><a class='srclink' href='../src/aho_corasick/state_id.rs.html#159' title='goto source code'>[src]</a></h4><h4 id='method.to_usize-4' class="method hidden"><code id='to_usize.v-5'>fn <a href='#method.to_usize' class='fnname'>to_usize</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/aho_corasick/state_id.rs.html#162' title='goto source code'>[src]</a></h4><h4 id='method.max_id-4' class="method hidden"><code id='max_id.v-5'>fn <a href='#method.max_id' class='fnname'>max_id</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/aho_corasick/state_id.rs.html#165' title='goto source code'>[src]</a></h4></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../implementors/aho_corasick/trait.StateID.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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse 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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "aho_corasick";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |