blob: 5f3d0b8fd9cb59832b66611047f7affaec2edecd [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/query-grammar/src/user_input_ast.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>user_input_ast.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_query_grammar/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="../../tantivy_query_grammar/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>
<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>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
</pre><pre class="rust"><code><span class="kw">use </span>std::fmt;
<span class="kw">use </span>std::fmt::{Debug, Formatter};
<span class="kw">use </span><span class="kw">crate</span>::Occur;
<span class="attribute">#[derive(PartialEq)]
</span><span class="kw">pub enum </span>UserInputLeaf {
Literal(UserInputLiteral),
All,
Range {
field: <span class="prelude-ty">Option</span>&lt;String&gt;,
lower: UserInputBound,
upper: UserInputBound,
},
Set {
field: <span class="prelude-ty">Option</span>&lt;String&gt;,
elements: Vec&lt;String&gt;,
},
}
<span class="kw">impl </span>Debug <span class="kw">for </span>UserInputLeaf {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, formatter: <span class="kw-2">&amp;mut </span>Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), fmt::Error&gt; {
<span class="kw">match </span><span class="self">self </span>{
UserInputLeaf::Literal(literal) =&gt; literal.fmt(formatter),
UserInputLeaf::Range {
<span class="kw-2">ref </span>field,
<span class="kw-2">ref </span>lower,
<span class="kw-2">ref </span>upper,
} =&gt; {
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>field) = field {
<span class="macro">write!</span>(formatter, <span class="string">&quot;\&quot;{}\&quot;:&quot;</span>, field)<span class="question-mark">?</span>;
}
lower.display_lower(formatter)<span class="question-mark">?</span>;
<span class="macro">write!</span>(formatter, <span class="string">&quot; TO &quot;</span>)<span class="question-mark">?</span>;
upper.display_upper(formatter)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
}
UserInputLeaf::Set { field, elements } =&gt; {
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>field) = field {
<span class="macro">write!</span>(formatter, <span class="string">&quot;\&quot;{}\&quot;: &quot;</span>, field)<span class="question-mark">?</span>;
}
<span class="macro">write!</span>(formatter, <span class="string">&quot;IN [&quot;</span>)<span class="question-mark">?</span>;
<span class="kw">for </span>(i, element) <span class="kw">in </span>elements.iter().enumerate() {
<span class="kw">if </span>i != <span class="number">0 </span>{
<span class="macro">write!</span>(formatter, <span class="string">&quot; &quot;</span>)<span class="question-mark">?</span>;
}
<span class="macro">write!</span>(formatter, <span class="string">&quot;\&quot;{}\&quot;&quot;</span>, element)<span class="question-mark">?</span>;
}
<span class="macro">write!</span>(formatter, <span class="string">&quot;]&quot;</span>)
}
UserInputLeaf::All =&gt; <span class="macro">write!</span>(formatter, <span class="string">&quot;*&quot;</span>),
}
}
}
<span class="attribute">#[derive(PartialEq)]
</span><span class="kw">pub struct </span>UserInputLiteral {
<span class="kw">pub </span>field_name: <span class="prelude-ty">Option</span>&lt;String&gt;,
<span class="kw">pub </span>phrase: String,
<span class="kw">pub </span>slop: u32,
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>UserInputLiteral {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, formatter: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; <span class="prelude-ty">Result</span>&lt;(), fmt::Error&gt; {
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>field) = <span class="self">self</span>.field_name {
<span class="macro">write!</span>(formatter, <span class="string">&quot;\&quot;{}\&quot;:&quot;</span>, field)<span class="question-mark">?</span>;
}
<span class="macro">write!</span>(formatter, <span class="string">&quot;\&quot;{}\&quot;&quot;</span>, <span class="self">self</span>.phrase)<span class="question-mark">?</span>;
<span class="kw">if </span><span class="self">self</span>.slop &gt; <span class="number">0 </span>{
<span class="macro">write!</span>(formatter, <span class="string">&quot;~{}&quot;</span>, <span class="self">self</span>.slop)<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(())
}
}
<span class="attribute">#[derive(PartialEq)]
</span><span class="kw">pub enum </span>UserInputBound {
Inclusive(String),
Exclusive(String),
Unbounded,
}
<span class="kw">impl </span>UserInputBound {
<span class="kw">fn </span>display_lower(<span class="kw-2">&amp;</span><span class="self">self</span>, formatter: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; <span class="prelude-ty">Result</span>&lt;(), fmt::Error&gt; {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
UserInputBound::Inclusive(<span class="kw-2">ref </span>word) =&gt; <span class="macro">write!</span>(formatter, <span class="string">&quot;[\&quot;{}\&quot;&quot;</span>, word),
UserInputBound::Exclusive(<span class="kw-2">ref </span>word) =&gt; <span class="macro">write!</span>(formatter, <span class="string">&quot;{{\&quot;{}\&quot;&quot;</span>, word),
UserInputBound::Unbounded =&gt; <span class="macro">write!</span>(formatter, <span class="string">&quot;{{\&quot;*\&quot;&quot;</span>),
}
}
<span class="kw">fn </span>display_upper(<span class="kw-2">&amp;</span><span class="self">self</span>, formatter: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; <span class="prelude-ty">Result</span>&lt;(), fmt::Error&gt; {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
UserInputBound::Inclusive(<span class="kw-2">ref </span>word) =&gt; <span class="macro">write!</span>(formatter, <span class="string">&quot;\&quot;{}\&quot;]&quot;</span>, word),
UserInputBound::Exclusive(<span class="kw-2">ref </span>word) =&gt; <span class="macro">write!</span>(formatter, <span class="string">&quot;\&quot;{}\&quot;}}&quot;</span>, word),
UserInputBound::Unbounded =&gt; <span class="macro">write!</span>(formatter, <span class="string">&quot;\&quot;*\&quot;}}&quot;</span>),
}
}
<span class="kw">pub fn </span>term_str(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>str {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
UserInputBound::Inclusive(<span class="kw-2">ref </span>contents) =&gt; contents,
UserInputBound::Exclusive(<span class="kw-2">ref </span>contents) =&gt; contents,
UserInputBound::Unbounded =&gt; <span class="string">&quot;*&quot;</span>,
}
}
}
<span class="kw">pub enum </span>UserInputAst {
Clause(Vec&lt;(<span class="prelude-ty">Option</span>&lt;Occur&gt;, UserInputAst)&gt;),
Leaf(Box&lt;UserInputLeaf&gt;),
Boost(Box&lt;UserInputAst&gt;, f64),
}
<span class="kw">impl </span>UserInputAst {
<span class="attribute">#[must_use]
</span><span class="kw">pub fn </span>unary(<span class="self">self</span>, occur: Occur) -&gt; UserInputAst {
UserInputAst::Clause(<span class="macro">vec!</span>[(<span class="prelude-val">Some</span>(occur), <span class="self">self</span>)])
}
<span class="kw">fn </span>compose(occur: Occur, asts: Vec&lt;UserInputAst&gt;) -&gt; UserInputAst {
<span class="macro">assert_ne!</span>(occur, Occur::MustNot);
<span class="macro">assert!</span>(!asts.is_empty());
<span class="kw">if </span>asts.len() == <span class="number">1 </span>{
asts.into_iter().next().unwrap() <span class="comment">//&lt; safe
</span>} <span class="kw">else </span>{
UserInputAst::Clause(
asts.into_iter()
.map(|ast: UserInputAst| (<span class="prelude-val">Some</span>(occur), ast))
.collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;(),
)
}
}
<span class="kw">pub fn </span>empty_query() -&gt; UserInputAst {
UserInputAst::Clause(Vec::default())
}
<span class="kw">pub fn </span>and(asts: Vec&lt;UserInputAst&gt;) -&gt; UserInputAst {
UserInputAst::compose(Occur::Must, asts)
}
<span class="kw">pub fn </span>or(asts: Vec&lt;UserInputAst&gt;) -&gt; UserInputAst {
UserInputAst::compose(Occur::Should, asts)
}
}
<span class="kw">impl </span>From&lt;UserInputLiteral&gt; <span class="kw">for </span>UserInputLeaf {
<span class="kw">fn </span>from(literal: UserInputLiteral) -&gt; UserInputLeaf {
UserInputLeaf::Literal(literal)
}
}
<span class="kw">impl </span>From&lt;UserInputLeaf&gt; <span class="kw">for </span>UserInputAst {
<span class="kw">fn </span>from(leaf: UserInputLeaf) -&gt; UserInputAst {
UserInputAst::Leaf(Box::new(leaf))
}
}
<span class="kw">fn </span>print_occur_ast(
occur_opt: <span class="prelude-ty">Option</span>&lt;Occur&gt;,
ast: <span class="kw-2">&amp;</span>UserInputAst,
formatter: <span class="kw-2">&amp;mut </span>fmt::Formatter,
) -&gt; fmt::Result {
<span class="kw">if let </span><span class="prelude-val">Some</span>(occur) = occur_opt {
<span class="macro">write!</span>(formatter, <span class="string">&quot;{}{:?}&quot;</span>, occur, ast)<span class="question-mark">?</span>;
} <span class="kw">else </span>{
<span class="macro">write!</span>(formatter, <span class="string">&quot;*{:?}&quot;</span>, ast)<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>UserInputAst {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, formatter: <span class="kw-2">&amp;mut </span>fmt::Formatter) -&gt; fmt::Result {
<span class="kw">match </span><span class="kw-2">*</span><span class="self">self </span>{
UserInputAst::Clause(<span class="kw-2">ref </span>subqueries) =&gt; {
<span class="kw">if </span>subqueries.is_empty() {
<span class="macro">write!</span>(formatter, <span class="string">&quot;&lt;emptyclause&gt;&quot;</span>)<span class="question-mark">?</span>;
} <span class="kw">else </span>{
<span class="macro">write!</span>(formatter, <span class="string">&quot;(&quot;</span>)<span class="question-mark">?</span>;
print_occur_ast(subqueries[<span class="number">0</span>].<span class="number">0</span>, <span class="kw-2">&amp;</span>subqueries[<span class="number">0</span>].<span class="number">1</span>, formatter)<span class="question-mark">?</span>;
<span class="kw">for </span>subquery <span class="kw">in </span><span class="kw-2">&amp;</span>subqueries[<span class="number">1</span>..] {
<span class="macro">write!</span>(formatter, <span class="string">&quot; &quot;</span>)<span class="question-mark">?</span>;
print_occur_ast(subquery.<span class="number">0</span>, <span class="kw-2">&amp;</span>subquery.<span class="number">1</span>, formatter)<span class="question-mark">?</span>;
}
<span class="macro">write!</span>(formatter, <span class="string">&quot;)&quot;</span>)<span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(())
}
UserInputAst::Leaf(<span class="kw-2">ref </span>subquery) =&gt; <span class="macro">write!</span>(formatter, <span class="string">&quot;{:?}&quot;</span>, subquery),
UserInputAst::Boost(<span class="kw-2">ref </span>leaf, boost) =&gt; <span class="macro">write!</span>(formatter, <span class="string">&quot;({:?})^{}&quot;</span>, leaf, boost),
}
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tantivy_query_grammar" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>