| <!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/git/checkouts/tantivy-65d0bbbddbbd5d02/433372d/src/tokenizer/remove_long.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>remove_long.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="../../../tantivy/index.html"><div class="logo-container"> |
| <img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../tantivy/index.html"> |
| <img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" 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> |
| </pre><pre class="rust"><code><span class="doccomment">//! # Example |
| //! ```rust |
| //! use tantivy::tokenizer::*; |
| //! |
| //! let tokenizer = TextAnalyzer::from(SimpleTokenizer) |
| //! .filter(RemoveLongFilter::limit(5)); |
| //! |
| //! let mut stream = tokenizer.token_stream("toolong nice"); |
| //! // because `toolong` is more than 5 characters, it is filtered |
| //! // out of the token stream. |
| //! assert_eq!(stream.next().unwrap().text, "nice"); |
| //! assert!(stream.next().is_none()); |
| //! ``` |
| </span><span class="kw">use super</span>::{Token, TokenFilter, TokenStream}; |
| <span class="kw">use </span><span class="kw">crate</span>::tokenizer::BoxTokenStream; |
| |
| <span class="doccomment">/// `RemoveLongFilter` removes tokens that are longer |
| /// than a given number of bytes (in UTF-8 representation). |
| /// |
| /// It is especially useful when indexing unconstrained content. |
| /// e.g. Mail containing base-64 encoded pictures etc. |
| </span><span class="attribute">#[derive(Clone)] |
| </span><span class="kw">pub struct </span>RemoveLongFilter { |
| length_limit: usize, |
| } |
| |
| <span class="kw">impl </span>RemoveLongFilter { |
| <span class="doccomment">/// Creates a `RemoveLongFilter` given a limit in bytes of the UTF-8 representation. |
| </span><span class="kw">pub fn </span>limit(length_limit: usize) -> RemoveLongFilter { |
| RemoveLongFilter { length_limit } |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> RemoveLongFilterStream<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>predicate(<span class="kw-2">&</span><span class="self">self</span>, token: <span class="kw-2">&</span>Token) -> bool { |
| token.text.len() < <span class="self">self</span>.token_length_limit |
| } |
| } |
| |
| <span class="kw">impl </span>TokenFilter <span class="kw">for </span>RemoveLongFilter { |
| <span class="kw">fn </span>transform<<span class="lifetime">'a</span>>(<span class="kw-2">&</span><span class="self">self</span>, token_stream: BoxTokenStream<<span class="lifetime">'a</span>>) -> BoxTokenStream<<span class="lifetime">'a</span>> { |
| BoxTokenStream::from(RemoveLongFilterStream { |
| token_length_limit: <span class="self">self</span>.length_limit, |
| tail: token_stream, |
| }) |
| } |
| } |
| |
| <span class="kw">pub struct </span>RemoveLongFilterStream<<span class="lifetime">'a</span>> { |
| token_length_limit: usize, |
| tail: BoxTokenStream<<span class="lifetime">'a</span>>, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> TokenStream <span class="kw">for </span>RemoveLongFilterStream<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>advance(<span class="kw-2">&mut </span><span class="self">self</span>) -> bool { |
| <span class="kw">while </span><span class="self">self</span>.tail.advance() { |
| <span class="kw">if </span><span class="self">self</span>.predicate(<span class="self">self</span>.tail.token()) { |
| <span class="kw">return </span><span class="bool-val">true</span>; |
| } |
| } |
| <span class="bool-val">false |
| </span>} |
| |
| <span class="kw">fn </span>token(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>Token { |
| <span class="self">self</span>.tail.token() |
| } |
| |
| <span class="kw">fn </span>token_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>Token { |
| <span class="self">self</span>.tail.token_mut() |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span><span class="kw">crate</span>::tokenizer::tests::assert_token; |
| <span class="kw">use </span><span class="kw">crate</span>::tokenizer::{RemoveLongFilter, SimpleTokenizer, TextAnalyzer, Token}; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_remove_long() { |
| <span class="kw">let </span>tokens = token_stream_helper(<span class="string">"hello tantivy, happy searching!"</span>); |
| <span class="macro">assert_eq!</span>(tokens.len(), <span class="number">2</span>); |
| assert_token(<span class="kw-2">&</span>tokens[<span class="number">0</span>], <span class="number">0</span>, <span class="string">"hello"</span>, <span class="number">0</span>, <span class="number">5</span>); |
| assert_token(<span class="kw-2">&</span>tokens[<span class="number">1</span>], <span class="number">2</span>, <span class="string">"happy"</span>, <span class="number">15</span>, <span class="number">20</span>); |
| } |
| |
| <span class="kw">fn </span>token_stream_helper(text: <span class="kw-2">&</span>str) -> Vec<Token> { |
| <span class="kw">let </span>a = TextAnalyzer::from(SimpleTokenizer).filter(RemoveLongFilter::limit(<span class="number">6</span>)); |
| <span class="kw">let </span><span class="kw-2">mut </span>token_stream = a.token_stream(text); |
| <span class="kw">let </span><span class="kw-2">mut </span>tokens: Vec<Token> = <span class="macro">vec!</span>[]; |
| <span class="kw">let </span><span class="kw-2">mut </span>add_token = |token: <span class="kw-2">&</span>Token| { |
| tokens.push(token.clone()); |
| }; |
| token_stream.process(<span class="kw-2">&mut </span>add_token); |
| tokens |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="tantivy" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
