blob: 0ac57c2558fbe2e6c5855d38f46c574597e5057a [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="Source of the Rust file `/root/.cargo/git/checkouts/tantivy-65d0bbbddbbd5d02/433372d/src/tokenizer/facet_tokenizer.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>facet_tokenizer.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>
<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>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
</pre><pre class="rust"><code><span class="kw">use super</span>::{BoxTokenStream, Token, TokenStream, Tokenizer};
<span class="kw">use </span><span class="kw">crate</span>::schema::FACET_SEP_BYTE;
<span class="doccomment">/// The `FacetTokenizer` process a `Facet` binary representation
/// and emits a token for all of its parent.
///
/// For instance, `/america/north_america/canada`
/// will emit the three following tokens
/// - `/america/north_america/canada`
/// - `/america/north_america`
/// - `/america`
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">pub struct </span>FacetTokenizer;
<span class="attribute">#[derive(Debug)]
</span><span class="kw">enum </span>State {
RootFacetNotEmitted,
UpToPosition(usize), <span class="comment">//&lt; we already emitted facet prefix up to &amp;text[..cursor]
</span>Terminated,
}
<span class="kw">pub struct </span>FacetTokenStream&lt;<span class="lifetime">&#39;a</span>&gt; {
text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
state: State,
token: Token,
}
<span class="kw">impl </span>Tokenizer <span class="kw">for </span>FacetTokenizer {
<span class="kw">fn </span>token_stream&lt;<span class="lifetime">&#39;a</span>&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str) -&gt; BoxTokenStream&lt;<span class="lifetime">&#39;a</span>&gt; {
FacetTokenStream {
text,
state: State::RootFacetNotEmitted, <span class="comment">//&lt; pos is the first char that has not been processed yet.
</span>token: Token::default(),
}
.into()
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; TokenStream <span class="kw">for </span>FacetTokenStream&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">fn </span>advance(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; bool {
<span class="kw">match </span><span class="self">self</span>.state {
State::RootFacetNotEmitted =&gt; {
<span class="self">self</span>.state = <span class="kw">if </span><span class="self">self</span>.text.is_empty() {
State::Terminated
} <span class="kw">else </span>{
State::UpToPosition(<span class="number">0</span>)
};
<span class="bool-val">true
</span>}
State::UpToPosition(cursor) =&gt; {
<span class="kw">let </span>bytes: <span class="kw-2">&amp;</span>[u8] = <span class="self">self</span>.text.as_bytes();
<span class="kw">if let </span><span class="prelude-val">Some</span>(next_sep_pos) = bytes[cursor + <span class="number">1</span>..]
.iter()
.cloned()
.position(|b| b == FACET_SEP_BYTE)
.map(|pos| cursor + <span class="number">1 </span>+ pos)
{
<span class="kw">let </span>facet_part = <span class="kw-2">&amp;</span><span class="self">self</span>.text[cursor..next_sep_pos];
<span class="self">self</span>.token.text.push_str(facet_part);
<span class="self">self</span>.state = State::UpToPosition(next_sep_pos);
} <span class="kw">else </span>{
<span class="kw">let </span>facet_part = <span class="kw-2">&amp;</span><span class="self">self</span>.text[cursor..];
<span class="self">self</span>.token.text.push_str(facet_part);
<span class="self">self</span>.state = State::Terminated;
}
<span class="bool-val">true
</span>}
State::Terminated =&gt; <span class="bool-val">false</span>,
}
}
<span class="kw">fn </span>token(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>Token {
<span class="kw-2">&amp;</span><span class="self">self</span>.token
}
<span class="kw">fn </span>token_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;mut </span>Token {
<span class="kw-2">&amp;mut </span><span class="self">self</span>.token
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span><span class="kw">super</span>::FacetTokenizer;
<span class="kw">use </span><span class="kw">crate</span>::schema::Facet;
<span class="kw">use </span><span class="kw">crate</span>::tokenizer::{Token, Tokenizer};
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_facet_tokenizer() {
<span class="kw">let </span>facet = Facet::from_path(<span class="macro">vec!</span>[<span class="string">&quot;top&quot;</span>, <span class="string">&quot;a&quot;</span>, <span class="string">&quot;b&quot;</span>]);
<span class="kw">let </span><span class="kw-2">mut </span>tokens = <span class="macro">vec!</span>[];
{
<span class="kw">let </span><span class="kw-2">mut </span>add_token = |token: <span class="kw-2">&amp;</span>Token| {
<span class="kw">let </span>facet = Facet::from_encoded(token.text.as_bytes().to_owned()).unwrap();
tokens.push(<span class="macro">format!</span>(<span class="string">&quot;{}&quot;</span>, facet));
};
FacetTokenizer
.token_stream(facet.encoded_str())
.process(<span class="kw-2">&amp;mut </span>add_token);
}
<span class="macro">assert_eq!</span>(tokens.len(), <span class="number">4</span>);
<span class="macro">assert_eq!</span>(tokens[<span class="number">0</span>], <span class="string">&quot;/&quot;</span>);
<span class="macro">assert_eq!</span>(tokens[<span class="number">1</span>], <span class="string">&quot;/top&quot;</span>);
<span class="macro">assert_eq!</span>(tokens[<span class="number">2</span>], <span class="string">&quot;/top/a&quot;</span>);
<span class="macro">assert_eq!</span>(tokens[<span class="number">3</span>], <span class="string">&quot;/top/a/b&quot;</span>);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_facet_tokenizer_root_facets() {
<span class="kw">let </span>facet = Facet::root();
<span class="kw">let </span><span class="kw-2">mut </span>tokens = <span class="macro">vec!</span>[];
{
<span class="kw">let </span><span class="kw-2">mut </span>add_token = |token: <span class="kw-2">&amp;</span>Token| {
<span class="kw">let </span>facet = Facet::from_encoded(token.text.as_bytes().to_owned()).unwrap(); <span class="comment">// ok test
</span>tokens.push(<span class="macro">format!</span>(<span class="string">&quot;{}&quot;</span>, facet));
};
FacetTokenizer
.token_stream(facet.encoded_str()) <span class="comment">// ok test
</span>.process(<span class="kw-2">&amp;mut </span>add_token);
}
<span class="macro">assert_eq!</span>(tokens.len(), <span class="number">1</span>);
<span class="macro">assert_eq!</span>(tokens[<span class="number">0</span>], <span class="string">&quot;/&quot;</span>);
}
}
</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>