| <!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/schema/field_entry.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>field_entry.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> |
| <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> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| </pre><pre class="rust"><code><span class="kw">use </span>serde::{Deserialize, Serialize}; |
| |
| <span class="kw">use </span><span class="kw">super</span>::ip_options::IpAddrOptions; |
| <span class="kw">use </span><span class="kw">crate</span>::schema::bytes_options::BytesOptions; |
| <span class="kw">use </span><span class="kw">crate</span>::schema::{ |
| is_valid_field_name, DateOptions, FacetOptions, FieldType, JsonObjectOptions, NumericOptions, |
| TextOptions, |
| }; |
| |
| <span class="doccomment">/// A `FieldEntry` represents a field and its configuration. |
| /// `Schema` are a collection of `FieldEntry` |
| /// |
| /// It consists of |
| /// - a field name |
| /// - a field type, itself wrapping up options describing |
| /// how the field should be indexed. |
| </span><span class="attribute">#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] |
| </span><span class="kw">pub struct </span>FieldEntry { |
| name: String, |
| <span class="attribute">#[serde(flatten)] |
| </span>field_type: FieldType, |
| } |
| |
| <span class="kw">impl </span>FieldEntry { |
| <span class="doccomment">/// Creates a new field entry given a name and a field type |
| </span><span class="kw">pub fn </span>new(field_name: String, field_type: FieldType) -> FieldEntry { |
| <span class="macro">assert!</span>(is_valid_field_name(<span class="kw-2">&</span>field_name)); |
| FieldEntry { |
| name: field_name, |
| field_type, |
| } |
| } |
| |
| <span class="doccomment">/// Creates a new text field entry. |
| </span><span class="kw">pub fn </span>new_text(field_name: String, text_options: TextOptions) -> FieldEntry { |
| <span class="self">Self</span>::new(field_name, FieldType::Str(text_options)) |
| } |
| |
| <span class="doccomment">/// Creates a new u64 field entry. |
| </span><span class="kw">pub fn </span>new_u64(field_name: String, int_options: NumericOptions) -> FieldEntry { |
| <span class="self">Self</span>::new(field_name, FieldType::U64(int_options)) |
| } |
| |
| <span class="doccomment">/// Creates a new i64 field entry. |
| </span><span class="kw">pub fn </span>new_i64(field_name: String, int_options: NumericOptions) -> FieldEntry { |
| <span class="self">Self</span>::new(field_name, FieldType::I64(int_options)) |
| } |
| |
| <span class="doccomment">/// Creates a new f64 field entry. |
| </span><span class="kw">pub fn </span>new_f64(field_name: String, f64_options: NumericOptions) -> FieldEntry { |
| <span class="self">Self</span>::new(field_name, FieldType::F64(f64_options)) |
| } |
| |
| <span class="doccomment">/// Creates a new bool field entry. |
| </span><span class="kw">pub fn </span>new_bool(field_name: String, bool_options: NumericOptions) -> FieldEntry { |
| <span class="self">Self</span>::new(field_name, FieldType::Bool(bool_options)) |
| } |
| |
| <span class="doccomment">/// Creates a new date field entry. |
| </span><span class="kw">pub fn </span>new_date(field_name: String, date_options: DateOptions) -> FieldEntry { |
| <span class="self">Self</span>::new(field_name, FieldType::Date(date_options)) |
| } |
| |
| <span class="doccomment">/// Creates a new ip address field entry. |
| </span><span class="kw">pub fn </span>new_ip_addr(field_name: String, ip_options: IpAddrOptions) -> FieldEntry { |
| <span class="self">Self</span>::new(field_name, FieldType::IpAddr(ip_options)) |
| } |
| |
| <span class="doccomment">/// Creates a field entry for a facet. |
| </span><span class="kw">pub fn </span>new_facet(field_name: String, facet_options: FacetOptions) -> FieldEntry { |
| <span class="self">Self</span>::new(field_name, FieldType::Facet(facet_options)) |
| } |
| |
| <span class="doccomment">/// Creates a field entry for a bytes field |
| </span><span class="kw">pub fn </span>new_bytes(field_name: String, bytes_options: BytesOptions) -> FieldEntry { |
| <span class="self">Self</span>::new(field_name, FieldType::Bytes(bytes_options)) |
| } |
| |
| <span class="doccomment">/// Creates a field entry for a json field |
| </span><span class="kw">pub fn </span>new_json(field_name: String, json_object_options: JsonObjectOptions) -> FieldEntry { |
| <span class="self">Self</span>::new(field_name, FieldType::JsonObject(json_object_options)) |
| } |
| |
| <span class="doccomment">/// Returns the name of the field |
| </span><span class="kw">pub fn </span>name(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str { |
| <span class="kw-2">&</span><span class="self">self</span>.name |
| } |
| |
| <span class="doccomment">/// Returns the field type |
| </span><span class="kw">pub fn </span>field_type(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>FieldType { |
| <span class="kw-2">&</span><span class="self">self</span>.field_type |
| } |
| |
| <span class="doccomment">/// Returns true if the field is indexed. |
| /// |
| /// An indexed field is searchable. |
| </span><span class="kw">pub fn </span>is_indexed(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.field_type.is_indexed() |
| } |
| |
| <span class="doccomment">/// Returns true if the field is normed |
| </span><span class="kw">pub fn </span>has_fieldnorms(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.field_type.has_fieldnorms() |
| } |
| |
| <span class="doccomment">/// Returns true if the field is a fast field |
| </span><span class="kw">pub fn </span>is_fast(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.field_type.is_fast() |
| } |
| |
| <span class="doccomment">/// Returns true if the field is stored |
| </span><span class="kw">pub fn </span>is_stored(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="kw">match </span><span class="self">self</span>.field_type { |
| FieldType::U64(<span class="kw-2">ref </span>options) |
| | FieldType::I64(<span class="kw-2">ref </span>options) |
| | FieldType::F64(<span class="kw-2">ref </span>options) |
| | FieldType::Bool(<span class="kw-2">ref </span>options) => options.is_stored(), |
| FieldType::Date(<span class="kw-2">ref </span>options) => options.is_stored(), |
| FieldType::Str(<span class="kw-2">ref </span>options) => options.is_stored(), |
| FieldType::Facet(<span class="kw-2">ref </span>options) => options.is_stored(), |
| FieldType::Bytes(<span class="kw-2">ref </span>options) => options.is_stored(), |
| FieldType::JsonObject(<span class="kw-2">ref </span>options) => options.is_stored(), |
| FieldType::IpAddr(<span class="kw-2">ref </span>options) => options.is_stored(), |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use </span>serde_json; |
| |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| <span class="kw">use </span><span class="kw">crate</span>::schema::{Schema, TextFieldIndexing, TEXT}; |
| <span class="kw">use </span><span class="kw">crate</span>::Index; |
| |
| <span class="attribute">#[test] |
| #[should_panic] |
| </span><span class="kw">fn </span>test_invalid_field_name_should_panic() { |
| FieldEntry::new_text(<span class="string">"-hello"</span>.to_string(), TEXT); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_json_serialization() { |
| <span class="kw">let </span>field_value = FieldEntry::new_text(String::from(<span class="string">"title"</span>), TEXT); |
| |
| <span class="kw">let </span>expected = <span class="string">r#"{ |
| "name": "title", |
| "type": "text", |
| "options": { |
| "indexing": { |
| "record": "position", |
| "fieldnorms": true, |
| "tokenizer": "default" |
| }, |
| "stored": false, |
| "fast": false |
| } |
| }"#</span>; |
| <span class="kw">let </span>field_value_json = serde_json::to_string_pretty(<span class="kw-2">&</span>field_value).unwrap(); |
| |
| <span class="macro">assert_eq!</span>(expected, <span class="kw-2">&</span>field_value_json); |
| |
| <span class="kw">let </span>field_value: FieldEntry = serde_json::from_str(expected).unwrap(); |
| |
| <span class="macro">assert_eq!</span>(<span class="string">"title"</span>, field_value.name); |
| |
| <span class="kw">match </span>field_value.field_type { |
| FieldType::Str(<span class="kw">_</span>) => {} |
| <span class="kw">_ </span>=> <span class="macro">panic!</span>(<span class="string">"expected FieldType::Str"</span>), |
| } |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_json_deserialization() { |
| <span class="kw">let </span>json_str = <span class="string">r#"{ |
| "name": "title", |
| "options": { |
| "indexing": { |
| "record": "position", |
| "fieldnorms": true, |
| "tokenizer": "default" |
| }, |
| "stored": false |
| }, |
| "type": "text" |
| }"#</span>; |
| <span class="kw">let </span>field_entry: FieldEntry = serde_json::from_str(json_str).unwrap(); |
| <span class="kw">match </span>field_entry.field_type { |
| FieldType::Str(<span class="kw">_</span>) => {} |
| <span class="kw">_ </span>=> <span class="macro">panic!</span>(<span class="string">"expected FieldType::Str"</span>), |
| } |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_missing_fieldnorms() -> <span class="kw">crate</span>::Result<()> { |
| <span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder(); |
| <span class="kw">let </span>no_field_norm = TextOptions::default() |
| .set_indexing_options(TextFieldIndexing::default().set_fieldnorms(<span class="bool-val">false</span>)); |
| <span class="kw">let </span>text = schema_builder.add_text_field(<span class="string">"text"</span>, no_field_norm); |
| <span class="kw">let </span>schema = schema_builder.build(); |
| <span class="kw">let </span>index = Index::create_in_ram(schema); |
| <span class="kw">let </span><span class="kw-2">mut </span>index_writer = index.writer_for_tests()<span class="question-mark">?</span>; |
| index_writer.add_document(<span class="macro">doc!</span>(text=><span class="string">"abc"</span>))<span class="question-mark">?</span>; |
| index_writer.commit()<span class="question-mark">?</span>; |
| <span class="kw">let </span>searcher = index.reader()<span class="question-mark">?</span>.searcher(); |
| <span class="kw">let </span>err = searcher.segment_reader(<span class="number">0u32</span>).get_fieldnorms_reader(text); |
| <span class="macro">assert!</span>(<span class="macro">matches!</span>(err, <span class="prelude-val">Err</span>(<span class="kw">crate</span>::TantivyError::SchemaError(<span class="kw">_</span>)))); |
| <span class="prelude-val">Ok</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> |
