327 lines
28 KiB
HTML
327 lines
28 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="Source of the Rust file `/home/newkirk/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/aho-corasick-1.1.4/src/lib.rs`."><title>lib.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="aho_corasick" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">aho_corasick/</div>lib.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">/*!
|
|
<a href=#2 id=2 data-nosnippet>2</a>A library for finding occurrences of many patterns at once. This library
|
|
<a href=#3 id=3 data-nosnippet>3</a>provides multiple pattern search principally through an implementation of the
|
|
<a href=#4 id=4 data-nosnippet>4</a>[Aho-Corasick algorithm](https://en.wikipedia.org/wiki/Aho%E2%80%93Corasick_algorithm),
|
|
<a href=#5 id=5 data-nosnippet>5</a>which builds a fast finite state machine for executing searches in linear time.
|
|
<a href=#6 id=6 data-nosnippet>6</a>
|
|
<a href=#7 id=7 data-nosnippet>7</a>Additionally, this library provides a number of configuration options for
|
|
<a href=#8 id=8 data-nosnippet>8</a>building the automaton that permit controlling the space versus time trade
|
|
<a href=#9 id=9 data-nosnippet>9</a>off. Other features include simple ASCII case insensitive matching, finding
|
|
<a href=#10 id=10 data-nosnippet>10</a>overlapping matches, replacements, searching streams and even searching and
|
|
<a href=#11 id=11 data-nosnippet>11</a>replacing text in streams.
|
|
<a href=#12 id=12 data-nosnippet>12</a>
|
|
<a href=#13 id=13 data-nosnippet>13</a>Finally, unlike most other Aho-Corasick implementations, this one
|
|
<a href=#14 id=14 data-nosnippet>14</a>supports enabling [leftmost-first](MatchKind::LeftmostFirst) or
|
|
<a href=#15 id=15 data-nosnippet>15</a>[leftmost-longest](MatchKind::LeftmostLongest) match semantics, using a
|
|
<a href=#16 id=16 data-nosnippet>16</a>(seemingly) novel alternative construction algorithm. For more details on what
|
|
<a href=#17 id=17 data-nosnippet>17</a>match semantics means, see the [`MatchKind`] type.
|
|
<a href=#18 id=18 data-nosnippet>18</a>
|
|
<a href=#19 id=19 data-nosnippet>19</a># Overview
|
|
<a href=#20 id=20 data-nosnippet>20</a>
|
|
<a href=#21 id=21 data-nosnippet>21</a>This section gives a brief overview of the primary types in this crate:
|
|
<a href=#22 id=22 data-nosnippet>22</a>
|
|
<a href=#23 id=23 data-nosnippet>23</a>* [`AhoCorasick`] is the primary type and represents an Aho-Corasick automaton.
|
|
<a href=#24 id=24 data-nosnippet>24</a>This is the type you use to execute searches.
|
|
<a href=#25 id=25 data-nosnippet>25</a>* [`AhoCorasickBuilder`] can be used to build an Aho-Corasick automaton, and
|
|
<a href=#26 id=26 data-nosnippet>26</a>supports configuring a number of options.
|
|
<a href=#27 id=27 data-nosnippet>27</a>* [`Match`] represents a single match reported by an Aho-Corasick automaton.
|
|
<a href=#28 id=28 data-nosnippet>28</a>Each match has two pieces of information: the pattern that matched and the
|
|
<a href=#29 id=29 data-nosnippet>29</a>start and end byte offsets corresponding to the position in the haystack at
|
|
<a href=#30 id=30 data-nosnippet>30</a>which it matched.
|
|
<a href=#31 id=31 data-nosnippet>31</a>
|
|
<a href=#32 id=32 data-nosnippet>32</a># Example: basic searching
|
|
<a href=#33 id=33 data-nosnippet>33</a>
|
|
<a href=#34 id=34 data-nosnippet>34</a>This example shows how to search for occurrences of multiple patterns
|
|
<a href=#35 id=35 data-nosnippet>35</a>simultaneously. Each match includes the pattern that matched along with the
|
|
<a href=#36 id=36 data-nosnippet>36</a>byte offsets of the match.
|
|
<a href=#37 id=37 data-nosnippet>37</a>
|
|
<a href=#38 id=38 data-nosnippet>38</a>```
|
|
<a href=#39 id=39 data-nosnippet>39</a>use aho_corasick::{AhoCorasick, PatternID};
|
|
<a href=#40 id=40 data-nosnippet>40</a>
|
|
<a href=#41 id=41 data-nosnippet>41</a>let patterns = &["apple", "maple", "Snapple"];
|
|
<a href=#42 id=42 data-nosnippet>42</a>let haystack = "Nobody likes maple in their apple flavored Snapple.";
|
|
<a href=#43 id=43 data-nosnippet>43</a>
|
|
<a href=#44 id=44 data-nosnippet>44</a>let ac = AhoCorasick::new(patterns).unwrap();
|
|
<a href=#45 id=45 data-nosnippet>45</a>let mut matches = vec![];
|
|
<a href=#46 id=46 data-nosnippet>46</a>for mat in ac.find_iter(haystack) {
|
|
<a href=#47 id=47 data-nosnippet>47</a> matches.push((mat.pattern(), mat.start(), mat.end()));
|
|
<a href=#48 id=48 data-nosnippet>48</a>}
|
|
<a href=#49 id=49 data-nosnippet>49</a>assert_eq!(matches, vec![
|
|
<a href=#50 id=50 data-nosnippet>50</a> (PatternID::must(1), 13, 18),
|
|
<a href=#51 id=51 data-nosnippet>51</a> (PatternID::must(0), 28, 33),
|
|
<a href=#52 id=52 data-nosnippet>52</a> (PatternID::must(2), 43, 50),
|
|
<a href=#53 id=53 data-nosnippet>53</a>]);
|
|
<a href=#54 id=54 data-nosnippet>54</a>```
|
|
<a href=#55 id=55 data-nosnippet>55</a>
|
|
<a href=#56 id=56 data-nosnippet>56</a># Example: case insensitivity
|
|
<a href=#57 id=57 data-nosnippet>57</a>
|
|
<a href=#58 id=58 data-nosnippet>58</a>This is like the previous example, but matches `Snapple` case insensitively
|
|
<a href=#59 id=59 data-nosnippet>59</a>using `AhoCorasickBuilder`:
|
|
<a href=#60 id=60 data-nosnippet>60</a>
|
|
<a href=#61 id=61 data-nosnippet>61</a>```
|
|
<a href=#62 id=62 data-nosnippet>62</a>use aho_corasick::{AhoCorasick, PatternID};
|
|
<a href=#63 id=63 data-nosnippet>63</a>
|
|
<a href=#64 id=64 data-nosnippet>64</a>let patterns = &["apple", "maple", "snapple"];
|
|
<a href=#65 id=65 data-nosnippet>65</a>let haystack = "Nobody likes maple in their apple flavored Snapple.";
|
|
<a href=#66 id=66 data-nosnippet>66</a>
|
|
<a href=#67 id=67 data-nosnippet>67</a>let ac = AhoCorasick::builder()
|
|
<a href=#68 id=68 data-nosnippet>68</a> .ascii_case_insensitive(true)
|
|
<a href=#69 id=69 data-nosnippet>69</a> .build(patterns)
|
|
<a href=#70 id=70 data-nosnippet>70</a> .unwrap();
|
|
<a href=#71 id=71 data-nosnippet>71</a>let mut matches = vec![];
|
|
<a href=#72 id=72 data-nosnippet>72</a>for mat in ac.find_iter(haystack) {
|
|
<a href=#73 id=73 data-nosnippet>73</a> matches.push((mat.pattern(), mat.start(), mat.end()));
|
|
<a href=#74 id=74 data-nosnippet>74</a>}
|
|
<a href=#75 id=75 data-nosnippet>75</a>assert_eq!(matches, vec![
|
|
<a href=#76 id=76 data-nosnippet>76</a> (PatternID::must(1), 13, 18),
|
|
<a href=#77 id=77 data-nosnippet>77</a> (PatternID::must(0), 28, 33),
|
|
<a href=#78 id=78 data-nosnippet>78</a> (PatternID::must(2), 43, 50),
|
|
<a href=#79 id=79 data-nosnippet>79</a>]);
|
|
<a href=#80 id=80 data-nosnippet>80</a>```
|
|
<a href=#81 id=81 data-nosnippet>81</a>
|
|
<a href=#82 id=82 data-nosnippet>82</a># Example: replacing matches in a stream
|
|
<a href=#83 id=83 data-nosnippet>83</a>
|
|
<a href=#84 id=84 data-nosnippet>84</a>This example shows how to execute a search and replace on a stream without
|
|
<a href=#85 id=85 data-nosnippet>85</a>loading the entire stream into memory first.
|
|
<a href=#86 id=86 data-nosnippet>86</a>
|
|
<a href=#87 id=87 data-nosnippet>87</a>```
|
|
<a href=#88 id=88 data-nosnippet>88</a># #[cfg(feature = "std")] {
|
|
<a href=#89 id=89 data-nosnippet>89</a>use aho_corasick::AhoCorasick;
|
|
<a href=#90 id=90 data-nosnippet>90</a>
|
|
<a href=#91 id=91 data-nosnippet>91</a># fn example() -> Result<(), std::io::Error> {
|
|
<a href=#92 id=92 data-nosnippet>92</a>let patterns = &["fox", "brown", "quick"];
|
|
<a href=#93 id=93 data-nosnippet>93</a>let replace_with = &["sloth", "grey", "slow"];
|
|
<a href=#94 id=94 data-nosnippet>94</a>
|
|
<a href=#95 id=95 data-nosnippet>95</a>// In a real example, these might be `std::fs::File`s instead. All you need to
|
|
<a href=#96 id=96 data-nosnippet>96</a>// do is supply a pair of `std::io::Read` and `std::io::Write` implementations.
|
|
<a href=#97 id=97 data-nosnippet>97</a>let rdr = "The quick brown fox.";
|
|
<a href=#98 id=98 data-nosnippet>98</a>let mut wtr = vec![];
|
|
<a href=#99 id=99 data-nosnippet>99</a>
|
|
<a href=#100 id=100 data-nosnippet>100</a>let ac = AhoCorasick::new(patterns).unwrap();
|
|
<a href=#101 id=101 data-nosnippet>101</a>ac.try_stream_replace_all(rdr.as_bytes(), &mut wtr, replace_with)?;
|
|
<a href=#102 id=102 data-nosnippet>102</a>assert_eq!(b"The slow grey sloth.".to_vec(), wtr);
|
|
<a href=#103 id=103 data-nosnippet>103</a># Ok(()) }; example().unwrap()
|
|
<a href=#104 id=104 data-nosnippet>104</a># }
|
|
<a href=#105 id=105 data-nosnippet>105</a>```
|
|
<a href=#106 id=106 data-nosnippet>106</a>
|
|
<a href=#107 id=107 data-nosnippet>107</a># Example: finding the leftmost first match
|
|
<a href=#108 id=108 data-nosnippet>108</a>
|
|
<a href=#109 id=109 data-nosnippet>109</a>In the textbook description of Aho-Corasick, its formulation is typically
|
|
<a href=#110 id=110 data-nosnippet>110</a>structured such that it reports all possible matches, even when they overlap
|
|
<a href=#111 id=111 data-nosnippet>111</a>with another. In many cases, overlapping matches may not be desired, such as
|
|
<a href=#112 id=112 data-nosnippet>112</a>the case of finding all successive non-overlapping matches like you might with
|
|
<a href=#113 id=113 data-nosnippet>113</a>a standard regular expression.
|
|
<a href=#114 id=114 data-nosnippet>114</a>
|
|
<a href=#115 id=115 data-nosnippet>115</a>Unfortunately the "obvious" way to modify the Aho-Corasick algorithm to do
|
|
<a href=#116 id=116 data-nosnippet>116</a>this doesn't always work in the expected way, since it will report matches as
|
|
<a href=#117 id=117 data-nosnippet>117</a>soon as they are seen. For example, consider matching the regex `Samwise|Sam`
|
|
<a href=#118 id=118 data-nosnippet>118</a>against the text `Samwise`. Most regex engines (that are Perl-like, or
|
|
<a href=#119 id=119 data-nosnippet>119</a>non-POSIX) will report `Samwise` as a match, but the standard Aho-Corasick
|
|
<a href=#120 id=120 data-nosnippet>120</a>algorithm modified for reporting non-overlapping matches will report `Sam`.
|
|
<a href=#121 id=121 data-nosnippet>121</a>
|
|
<a href=#122 id=122 data-nosnippet>122</a>A novel contribution of this library is the ability to change the match
|
|
<a href=#123 id=123 data-nosnippet>123</a>semantics of Aho-Corasick (without additional search time overhead) such that
|
|
<a href=#124 id=124 data-nosnippet>124</a>`Samwise` is reported instead. For example, here's the standard approach:
|
|
<a href=#125 id=125 data-nosnippet>125</a>
|
|
<a href=#126 id=126 data-nosnippet>126</a>```
|
|
<a href=#127 id=127 data-nosnippet>127</a>use aho_corasick::AhoCorasick;
|
|
<a href=#128 id=128 data-nosnippet>128</a>
|
|
<a href=#129 id=129 data-nosnippet>129</a>let patterns = &["Samwise", "Sam"];
|
|
<a href=#130 id=130 data-nosnippet>130</a>let haystack = "Samwise";
|
|
<a href=#131 id=131 data-nosnippet>131</a>
|
|
<a href=#132 id=132 data-nosnippet>132</a>let ac = AhoCorasick::new(patterns).unwrap();
|
|
<a href=#133 id=133 data-nosnippet>133</a>let mat = ac.find(haystack).expect("should have a match");
|
|
<a href=#134 id=134 data-nosnippet>134</a>assert_eq!("Sam", &haystack[mat.start()..mat.end()]);
|
|
<a href=#135 id=135 data-nosnippet>135</a>```
|
|
<a href=#136 id=136 data-nosnippet>136</a>
|
|
<a href=#137 id=137 data-nosnippet>137</a>And now here's the leftmost-first version, which matches how a Perl-like
|
|
<a href=#138 id=138 data-nosnippet>138</a>regex will work:
|
|
<a href=#139 id=139 data-nosnippet>139</a>
|
|
<a href=#140 id=140 data-nosnippet>140</a>```
|
|
<a href=#141 id=141 data-nosnippet>141</a>use aho_corasick::{AhoCorasick, MatchKind};
|
|
<a href=#142 id=142 data-nosnippet>142</a>
|
|
<a href=#143 id=143 data-nosnippet>143</a>let patterns = &["Samwise", "Sam"];
|
|
<a href=#144 id=144 data-nosnippet>144</a>let haystack = "Samwise";
|
|
<a href=#145 id=145 data-nosnippet>145</a>
|
|
<a href=#146 id=146 data-nosnippet>146</a>let ac = AhoCorasick::builder()
|
|
<a href=#147 id=147 data-nosnippet>147</a> .match_kind(MatchKind::LeftmostFirst)
|
|
<a href=#148 id=148 data-nosnippet>148</a> .build(patterns)
|
|
<a href=#149 id=149 data-nosnippet>149</a> .unwrap();
|
|
<a href=#150 id=150 data-nosnippet>150</a>let mat = ac.find(haystack).expect("should have a match");
|
|
<a href=#151 id=151 data-nosnippet>151</a>assert_eq!("Samwise", &haystack[mat.start()..mat.end()]);
|
|
<a href=#152 id=152 data-nosnippet>152</a>```
|
|
<a href=#153 id=153 data-nosnippet>153</a>
|
|
<a href=#154 id=154 data-nosnippet>154</a>In addition to leftmost-first semantics, this library also supports
|
|
<a href=#155 id=155 data-nosnippet>155</a>leftmost-longest semantics, which match the POSIX behavior of a regular
|
|
<a href=#156 id=156 data-nosnippet>156</a>expression alternation. See [`MatchKind`] for more details.
|
|
<a href=#157 id=157 data-nosnippet>157</a>
|
|
<a href=#158 id=158 data-nosnippet>158</a># Prefilters
|
|
<a href=#159 id=159 data-nosnippet>159</a>
|
|
<a href=#160 id=160 data-nosnippet>160</a>While an Aho-Corasick automaton can perform admirably when compared to more
|
|
<a href=#161 id=161 data-nosnippet>161</a>naive solutions, it is generally slower than more specialized algorithms that
|
|
<a href=#162 id=162 data-nosnippet>162</a>are accelerated using vector instructions such as SIMD.
|
|
<a href=#163 id=163 data-nosnippet>163</a>
|
|
<a href=#164 id=164 data-nosnippet>164</a>For that reason, this library will internally use a "prefilter" to attempt
|
|
<a href=#165 id=165 data-nosnippet>165</a>to accelerate searches when possible. Currently, this library has several
|
|
<a href=#166 id=166 data-nosnippet>166</a>different algorithms it might use depending on the patterns provided. Once the
|
|
<a href=#167 id=167 data-nosnippet>167</a>number of patterns gets too big, prefilters are no longer used.
|
|
<a href=#168 id=168 data-nosnippet>168</a>
|
|
<a href=#169 id=169 data-nosnippet>169</a>While a prefilter is generally good to have on by default since it works
|
|
<a href=#170 id=170 data-nosnippet>170</a>well in the common case, it can lead to less predictable or even sub-optimal
|
|
<a href=#171 id=171 data-nosnippet>171</a>performance in some cases. For that reason, prefilters can be explicitly
|
|
<a href=#172 id=172 data-nosnippet>172</a>disabled via [`AhoCorasickBuilder::prefilter`].
|
|
<a href=#173 id=173 data-nosnippet>173</a>
|
|
<a href=#174 id=174 data-nosnippet>174</a># Lower level APIs
|
|
<a href=#175 id=175 data-nosnippet>175</a>
|
|
<a href=#176 id=176 data-nosnippet>176</a>This crate also provides several sub-modules that collectively expose many of
|
|
<a href=#177 id=177 data-nosnippet>177</a>the implementation details of the main [`AhoCorasick`] type. Most users of this
|
|
<a href=#178 id=178 data-nosnippet>178</a>library can completely ignore the submodules and their contents, but if you
|
|
<a href=#179 id=179 data-nosnippet>179</a>needed finer grained control, some parts of them may be useful to you. Here is
|
|
<a href=#180 id=180 data-nosnippet>180</a>a brief overview of each and why you might want to use them:
|
|
<a href=#181 id=181 data-nosnippet>181</a>
|
|
<a href=#182 id=182 data-nosnippet>182</a>* The [`packed`] sub-module contains a lower level API for using fast
|
|
<a href=#183 id=183 data-nosnippet>183</a>vectorized routines for finding a small number of patterns in a haystack.
|
|
<a href=#184 id=184 data-nosnippet>184</a>You might want to use this API when you want to completely side-step using
|
|
<a href=#185 id=185 data-nosnippet>185</a>Aho-Corasick automata. Otherwise, the fast vectorized routines are used
|
|
<a href=#186 id=186 data-nosnippet>186</a>automatically as prefilters for `AhoCorasick` searches whenever possible.
|
|
<a href=#187 id=187 data-nosnippet>187</a>* The [`automaton`] sub-module provides a lower level finite state
|
|
<a href=#188 id=188 data-nosnippet>188</a>machine interface that the various Aho-Corasick implementations in
|
|
<a href=#189 id=189 data-nosnippet>189</a>this crate implement. This sub-module's main contribution is the
|
|
<a href=#190 id=190 data-nosnippet>190</a>[`Automaton`](automaton::Automaton) trait, which permits manually walking the
|
|
<a href=#191 id=191 data-nosnippet>191</a>state transitions of an Aho-Corasick automaton.
|
|
<a href=#192 id=192 data-nosnippet>192</a>* The [`dfa`] and [`nfa`] sub-modules provide DFA and NFA implementations of
|
|
<a href=#193 id=193 data-nosnippet>193</a>the aforementioned `Automaton` trait. The main reason one might want to use
|
|
<a href=#194 id=194 data-nosnippet>194</a>these sub-modules is to get access to a type that implements the `Automaton`
|
|
<a href=#195 id=195 data-nosnippet>195</a>trait. (The top-level `AhoCorasick` type does not implement the `Automaton`
|
|
<a href=#196 id=196 data-nosnippet>196</a>trait.)
|
|
<a href=#197 id=197 data-nosnippet>197</a>
|
|
<a href=#198 id=198 data-nosnippet>198</a>As mentioned above, if you aren't sure whether you need these sub-modules,
|
|
<a href=#199 id=199 data-nosnippet>199</a>you should be able to safely ignore them and just focus on the [`AhoCorasick`]
|
|
<a href=#200 id=200 data-nosnippet>200</a>type.
|
|
<a href=#201 id=201 data-nosnippet>201</a>
|
|
<a href=#202 id=202 data-nosnippet>202</a># Crate features
|
|
<a href=#203 id=203 data-nosnippet>203</a>
|
|
<a href=#204 id=204 data-nosnippet>204</a>This crate exposes a few features for controlling dependency usage and whether
|
|
<a href=#205 id=205 data-nosnippet>205</a>this crate can be used without the standard library.
|
|
<a href=#206 id=206 data-nosnippet>206</a>
|
|
<a href=#207 id=207 data-nosnippet>207</a>* **std** -
|
|
<a href=#208 id=208 data-nosnippet>208</a> Enables support for the standard library. This feature is enabled by
|
|
<a href=#209 id=209 data-nosnippet>209</a> default. When disabled, only `core` and `alloc` are used. At an API
|
|
<a href=#210 id=210 data-nosnippet>210</a> level, enabling `std` enables `std::error::Error` trait impls for the
|
|
<a href=#211 id=211 data-nosnippet>211</a> various error types, and higher level stream search routines such as
|
|
<a href=#212 id=212 data-nosnippet>212</a> [`AhoCorasick::try_stream_find_iter`]. But the `std` feature is also required
|
|
<a href=#213 id=213 data-nosnippet>213</a> to enable vectorized prefilters. Prefilters can greatly accelerate searches,
|
|
<a href=#214 id=214 data-nosnippet>214</a> but generally only apply when the number of patterns is small (less than
|
|
<a href=#215 id=215 data-nosnippet>215</a> ~100).
|
|
<a href=#216 id=216 data-nosnippet>216</a>* **perf-literal** -
|
|
<a href=#217 id=217 data-nosnippet>217</a> Enables support for literal prefilters that use vectorized routines from
|
|
<a href=#218 id=218 data-nosnippet>218</a> external crates. This feature is enabled by default. If you're only using
|
|
<a href=#219 id=219 data-nosnippet>219</a> Aho-Corasick for large numbers of patterns or otherwise can abide lower
|
|
<a href=#220 id=220 data-nosnippet>220</a> throughput when searching with a small number of patterns, then it is
|
|
<a href=#221 id=221 data-nosnippet>221</a> reasonable to disable this feature.
|
|
<a href=#222 id=222 data-nosnippet>222</a>* **logging** -
|
|
<a href=#223 id=223 data-nosnippet>223</a> Enables a dependency on the `log` crate and emits messages to aide in
|
|
<a href=#224 id=224 data-nosnippet>224</a> diagnostics. This feature is disabled by default.
|
|
<a href=#225 id=225 data-nosnippet>225</a>*/
|
|
<a href=#226 id=226 data-nosnippet>226</a>
|
|
<a href=#227 id=227 data-nosnippet>227</a></span><span class="attr">#![no_std]
|
|
<a href=#228 id=228 data-nosnippet>228</a>#![deny(missing_docs)]
|
|
<a href=#229 id=229 data-nosnippet>229</a>#![deny(rustdoc::broken_intra_doc_links)]
|
|
<a href=#230 id=230 data-nosnippet>230</a>#![cfg_attr(docsrs, feature(doc_cfg))]
|
|
<a href=#231 id=231 data-nosnippet>231</a>
|
|
<a href=#232 id=232 data-nosnippet>232</a></span><span class="kw">extern crate </span>alloc;
|
|
<a href=#233 id=233 data-nosnippet>233</a><span class="attr">#[cfg(any(test, feature = <span class="string">"std"</span>))]
|
|
<a href=#234 id=234 data-nosnippet>234</a></span><span class="kw">extern crate </span>std;
|
|
<a href=#235 id=235 data-nosnippet>235</a>
|
|
<a href=#236 id=236 data-nosnippet>236</a><span class="attr">#[cfg(doctest)]
|
|
<a href=#237 id=237 data-nosnippet>237</a></span><span class="macro">doc_comment::doctest!</span>(<span class="string">"../README.md"</span>);
|
|
<a href=#238 id=238 data-nosnippet>238</a>
|
|
<a href=#239 id=239 data-nosnippet>239</a><span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#240 id=240 data-nosnippet>240</a></span><span class="kw">pub use </span><span class="kw">crate</span>::ahocorasick::StreamFindIter;
|
|
<a href=#241 id=241 data-nosnippet>241</a><span class="kw">pub use crate</span>::{
|
|
<a href=#242 id=242 data-nosnippet>242</a> ahocorasick::{
|
|
<a href=#243 id=243 data-nosnippet>243</a> AhoCorasick, AhoCorasickBuilder, AhoCorasickKind, FindIter,
|
|
<a href=#244 id=244 data-nosnippet>244</a> FindOverlappingIter,
|
|
<a href=#245 id=245 data-nosnippet>245</a> },
|
|
<a href=#246 id=246 data-nosnippet>246</a> util::{
|
|
<a href=#247 id=247 data-nosnippet>247</a> error::{BuildError, MatchError, MatchErrorKind},
|
|
<a href=#248 id=248 data-nosnippet>248</a> primitives::{PatternID, PatternIDError},
|
|
<a href=#249 id=249 data-nosnippet>249</a> search::{Anchored, Input, Match, MatchKind, Span, StartKind},
|
|
<a href=#250 id=250 data-nosnippet>250</a> },
|
|
<a href=#251 id=251 data-nosnippet>251</a>};
|
|
<a href=#252 id=252 data-nosnippet>252</a>
|
|
<a href=#253 id=253 data-nosnippet>253</a><span class="attr">#[macro_use]
|
|
<a href=#254 id=254 data-nosnippet>254</a></span><span class="kw">mod </span>macros;
|
|
<a href=#255 id=255 data-nosnippet>255</a>
|
|
<a href=#256 id=256 data-nosnippet>256</a><span class="kw">mod </span>ahocorasick;
|
|
<a href=#257 id=257 data-nosnippet>257</a><span class="kw">pub mod </span>automaton;
|
|
<a href=#258 id=258 data-nosnippet>258</a><span class="kw">pub mod </span>dfa;
|
|
<a href=#259 id=259 data-nosnippet>259</a><span class="kw">pub mod </span>nfa;
|
|
<a href=#260 id=260 data-nosnippet>260</a><span class="kw">pub mod </span>packed;
|
|
<a href=#261 id=261 data-nosnippet>261</a><span class="attr">#[cfg(test)]
|
|
<a href=#262 id=262 data-nosnippet>262</a></span><span class="kw">mod </span>tests;
|
|
<a href=#263 id=263 data-nosnippet>263</a><span class="comment">// I wrote out the module for implementing fst::Automaton only to later realize
|
|
<a href=#264 id=264 data-nosnippet>264</a>// that this would make fst a public dependency and fst is not at 1.0 yet. I
|
|
<a href=#265 id=265 data-nosnippet>265</a>// decided to just keep the code in tree, but build it only during tests.
|
|
<a href=#266 id=266 data-nosnippet>266</a>//
|
|
<a href=#267 id=267 data-nosnippet>267</a>// TODO: I think I've changed my mind again. I'm considering pushing it out
|
|
<a href=#268 id=268 data-nosnippet>268</a>// into either a separate crate or into 'fst' directly as an optional feature.
|
|
<a href=#269 id=269 data-nosnippet>269</a>// #[cfg(test)]
|
|
<a href=#270 id=270 data-nosnippet>270</a>// #[allow(dead_code)]
|
|
<a href=#271 id=271 data-nosnippet>271</a>// mod transducer;
|
|
<a href=#272 id=272 data-nosnippet>272</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>util;
|
|
<a href=#273 id=273 data-nosnippet>273</a>
|
|
<a href=#274 id=274 data-nosnippet>274</a><span class="attr">#[cfg(test)]
|
|
<a href=#275 id=275 data-nosnippet>275</a></span><span class="kw">mod </span>testoibits {
|
|
<a href=#276 id=276 data-nosnippet>276</a> <span class="kw">use </span>std::panic::{RefUnwindSafe, UnwindSafe};
|
|
<a href=#277 id=277 data-nosnippet>277</a>
|
|
<a href=#278 id=278 data-nosnippet>278</a> <span class="kw">use super</span>::<span class="kw-2">*</span>;
|
|
<a href=#279 id=279 data-nosnippet>279</a>
|
|
<a href=#280 id=280 data-nosnippet>280</a> <span class="kw">fn </span>assert_all<T: Send + Sync + UnwindSafe + RefUnwindSafe>() {}
|
|
<a href=#281 id=281 data-nosnippet>281</a>
|
|
<a href=#282 id=282 data-nosnippet>282</a> <span class="attr">#[test]
|
|
<a href=#283 id=283 data-nosnippet>283</a> </span><span class="kw">fn </span>oibits_main() {
|
|
<a href=#284 id=284 data-nosnippet>284</a> assert_all::<AhoCorasick>();
|
|
<a href=#285 id=285 data-nosnippet>285</a> assert_all::<AhoCorasickBuilder>();
|
|
<a href=#286 id=286 data-nosnippet>286</a> assert_all::<AhoCorasickKind>();
|
|
<a href=#287 id=287 data-nosnippet>287</a> assert_all::<FindIter>();
|
|
<a href=#288 id=288 data-nosnippet>288</a> assert_all::<FindOverlappingIter>();
|
|
<a href=#289 id=289 data-nosnippet>289</a>
|
|
<a href=#290 id=290 data-nosnippet>290</a> assert_all::<BuildError>();
|
|
<a href=#291 id=291 data-nosnippet>291</a> assert_all::<MatchError>();
|
|
<a href=#292 id=292 data-nosnippet>292</a> assert_all::<MatchErrorKind>();
|
|
<a href=#293 id=293 data-nosnippet>293</a>
|
|
<a href=#294 id=294 data-nosnippet>294</a> assert_all::<Anchored>();
|
|
<a href=#295 id=295 data-nosnippet>295</a> assert_all::<Input>();
|
|
<a href=#296 id=296 data-nosnippet>296</a> assert_all::<Match>();
|
|
<a href=#297 id=297 data-nosnippet>297</a> assert_all::<MatchKind>();
|
|
<a href=#298 id=298 data-nosnippet>298</a> assert_all::<Span>();
|
|
<a href=#299 id=299 data-nosnippet>299</a> assert_all::<StartKind>();
|
|
<a href=#300 id=300 data-nosnippet>300</a> }
|
|
<a href=#301 id=301 data-nosnippet>301</a>
|
|
<a href=#302 id=302 data-nosnippet>302</a> <span class="attr">#[test]
|
|
<a href=#303 id=303 data-nosnippet>303</a> </span><span class="kw">fn </span>oibits_automaton() {
|
|
<a href=#304 id=304 data-nosnippet>304</a> <span class="kw">use crate</span>::{automaton, dfa::DFA};
|
|
<a href=#305 id=305 data-nosnippet>305</a>
|
|
<a href=#306 id=306 data-nosnippet>306</a> assert_all::<automaton::FindIter<DFA>>();
|
|
<a href=#307 id=307 data-nosnippet>307</a> assert_all::<automaton::FindOverlappingIter<DFA>>();
|
|
<a href=#308 id=308 data-nosnippet>308</a> <span class="attr">#[cfg(feature = <span class="string">"std"</span>)]
|
|
<a href=#309 id=309 data-nosnippet>309</a> </span>assert_all::<automaton::StreamFindIter<DFA, std::io::Stdin>>();
|
|
<a href=#310 id=310 data-nosnippet>310</a> assert_all::<automaton::OverlappingState>();
|
|
<a href=#311 id=311 data-nosnippet>311</a>
|
|
<a href=#312 id=312 data-nosnippet>312</a> assert_all::<automaton::Prefilter>();
|
|
<a href=#313 id=313 data-nosnippet>313</a> assert_all::<automaton::Candidate>();
|
|
<a href=#314 id=314 data-nosnippet>314</a> }
|
|
<a href=#315 id=315 data-nosnippet>315</a>
|
|
<a href=#316 id=316 data-nosnippet>316</a> <span class="attr">#[test]
|
|
<a href=#317 id=317 data-nosnippet>317</a> </span><span class="kw">fn </span>oibits_packed() {
|
|
<a href=#318 id=318 data-nosnippet>318</a> <span class="kw">use </span><span class="kw">crate</span>::packed;
|
|
<a href=#319 id=319 data-nosnippet>319</a>
|
|
<a href=#320 id=320 data-nosnippet>320</a> assert_all::<packed::Config>();
|
|
<a href=#321 id=321 data-nosnippet>321</a> assert_all::<packed::Builder>();
|
|
<a href=#322 id=322 data-nosnippet>322</a> assert_all::<packed::Searcher>();
|
|
<a href=#323 id=323 data-nosnippet>323</a> assert_all::<packed::FindIter>();
|
|
<a href=#324 id=324 data-nosnippet>324</a> assert_all::<packed::MatchKind>();
|
|
<a href=#325 id=325 data-nosnippet>325</a> }
|
|
<a href=#326 id=326 data-nosnippet>326</a>}
|
|
</code></pre></div></section></main></body></html> |