| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/aho-corasick-1.0.2/src/packed/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs - source</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="../../../source-script.js"></script><script defer src="../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../aho_corasick/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| </pre><pre class="rust"><code><span class="doccomment">/*! |
| Provides packed multiple substring search, principally for a small number of |
| patterns. |
| |
| This sub-module provides vectorized routines for quickly finding |
| matches of a small number of patterns. In general, users of this crate |
| shouldn't need to interface with this module directly, as the primary |
| [`AhoCorasick`](crate::AhoCorasick) searcher will use these routines |
| automatically as a prefilter when applicable. However, in some cases, callers |
| may want to bypass the Aho-Corasick machinery entirely and use this vectorized |
| searcher directly. |
| |
| # Overview |
| |
| The primary types in this sub-module are: |
| |
| * [`Searcher`] executes the actual search algorithm to report matches in a |
| haystack. |
| * [`Builder`] accumulates patterns incrementally and can construct a |
| `Searcher`. |
| * [`Config`] permits tuning the searcher, and itself will produce a `Builder` |
| (which can then be used to build a `Searcher`). Currently, the only tuneable |
| knob are the match semantics, but this may be expanded in the future. |
| |
| # Examples |
| |
| This example shows how to create a searcher from an iterator of patterns. |
| By default, leftmost-first match semantics are used. (See the top-level |
| [`MatchKind`] type for more details about match semantics, which apply |
| similarly to packed substring search.) |
| |
| ``` |
| use aho_corasick::{packed::{MatchKind, Searcher}, PatternID}; |
| |
| # fn example() -> Option<()> { |
| let searcher = Searcher::new(["foobar", "foo"].iter().cloned())?; |
| let matches: Vec<PatternID> = searcher |
| .find_iter("foobar") |
| .map(|mat| mat.pattern()) |
| .collect(); |
| assert_eq!(vec![PatternID::ZERO], matches); |
| # Some(()) } |
| # if cfg!(all(feature = "std", target_arch = "x86_64")) { |
| # example().unwrap() |
| # } else { |
| # assert!(example().is_none()); |
| # } |
| ``` |
| |
| This example shows how to use [`Config`] to change the match semantics to |
| leftmost-longest: |
| |
| ``` |
| use aho_corasick::{packed::{Config, MatchKind}, PatternID}; |
| |
| # fn example() -> Option<()> { |
| let searcher = Config::new() |
| .match_kind(MatchKind::LeftmostLongest) |
| .builder() |
| .add("foo") |
| .add("foobar") |
| .build()?; |
| let matches: Vec<PatternID> = searcher |
| .find_iter("foobar") |
| .map(|mat| mat.pattern()) |
| .collect(); |
| assert_eq!(vec![PatternID::must(1)], matches); |
| # Some(()) } |
| # if cfg!(all(feature = "std", target_arch = "x86_64")) { |
| # example().unwrap() |
| # } else { |
| # assert!(example().is_none()); |
| # } |
| ``` |
| |
| # Packed substring searching |
| |
| Packed substring searching refers to the use of SIMD (Single Instruction, |
| Multiple Data) to accelerate the detection of matches in a haystack. Unlike |
| conventional algorithms, such as Aho-Corasick, SIMD algorithms for substring |
| search tend to do better with a small number of patterns, where as Aho-Corasick |
| generally maintains reasonably consistent performance regardless of the number |
| of patterns you give it. Because of this, the vectorized searcher in this |
| sub-module cannot be used as a general purpose searcher, since building the |
| searcher may fail even when given a small number of patterns. However, in |
| exchange, when searching for a small number of patterns, searching can be quite |
| a bit faster than Aho-Corasick (sometimes by an order of magnitude). |
| |
| The key take away here is that constructing a searcher from a list of patterns |
| is a fallible operation with no clear rules for when it will fail. While the |
| precise conditions under which building a searcher can fail is specifically an |
| implementation detail, here are some common reasons: |
| |
| * Too many patterns were given. Typically, the limit is on the order of 100 or |
| so, but this limit may fluctuate based on available CPU features. |
| * The available packed algorithms require CPU features that aren't available. |
| For example, currently, this crate only provides packed algorithms for |
| `x86_64`. Therefore, constructing a packed searcher on any other target |
| (e.g., ARM) will always fail. |
| * Zero patterns were given, or one of the patterns given was empty. Packed |
| searchers require at least one pattern and that all patterns are non-empty. |
| * Something else about the nature of the patterns (typically based on |
| heuristics) suggests that a packed searcher would perform very poorly, so |
| no searcher is built. |
| */ |
| |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::packed::api::{Builder, Config, FindIter, MatchKind, Searcher}; |
| |
| <span class="kw">mod </span>api; |
| <span class="kw">mod </span>pattern; |
| <span class="kw">mod </span>rabinkarp; |
| <span class="kw">mod </span>teddy; |
| <span class="attribute">#[cfg(all(feature = <span class="string">"std"</span>, test))] |
| </span><span class="kw">mod </span>tests; |
| <span class="attribute">#[cfg(all(feature = <span class="string">"std"</span>, target_arch = <span class="string">"x86_64"</span>))] |
| </span><span class="kw">mod </span>vector; |
| </code></pre></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> |
