| <!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/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.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> |
| </pre><pre class="rust"><code><span class="doccomment">//! Schema definition for tantivy's indices. |
| //! |
| //! # Setting your schema in Tantivy |
| //! |
| //! Tantivy has a very strict schema. |
| //! The schema defines information about the fields your index contains, that is, for each field: |
| //! |
| //! - the field name (may only contain letters `[a-zA-Z]`, number `[0-9]`, and `_`) |
| //! - the type of the field (currently only `text` and `u64` are supported) |
| //! - how the field should be indexed / stored. |
| //! |
| //! This very last point is critical as it will enable / disable some of the functionality |
| //! for your index. |
| //! |
| //! Tantivy's schema is stored within the `meta.json` file at the root of your |
| //! directory. |
| //! |
| //! |
| //! |
| //! # Building a schema "programmatically" |
| //! |
| //! |
| //! ## Setting a text field |
| //! |
| //! ### Example |
| //! |
| //! ``` |
| //! use tantivy::schema::*; |
| //! let mut schema_builder = Schema::builder(); |
| //! let title_options = TextOptions::default() |
| //! .set_stored() |
| //! .set_indexing_options(TextFieldIndexing::default() |
| //! .set_tokenizer("default") |
| //! .set_index_option(IndexRecordOption::WithFreqsAndPositions)); |
| //! schema_builder.add_text_field("title", title_options); |
| //! let schema = schema_builder.build(); |
| //! ``` |
| //! |
| //! We can split the problem of generating a search result page into two phases: |
| //! |
| //! - identifying the list of 10 or so documents to be displayed (Conceptually `query -> doc_ids[]`) |
| //! - for each of these documents, retrieving the information required to generate the search |
| //! results page. (`doc_ids[] -> Document[]`) |
| //! |
| //! In the first phase, the ability to search for documents by the given field is determined by the |
| //! [`IndexRecordOption`] of our [`TextOptions`]. |
| //! |
| //! The effect of each possible setting is described more in detail in [`TextOptions`]. |
| //! |
| //! On the other hand setting the field as stored or not determines whether the field should be |
| //! returned when [`Searcher::doc()`](crate::Searcher::doc) is called. |
| //! |
| //! |
| //! ## Setting a u64, a i64 or a f64 field |
| //! |
| //! ### Example |
| //! |
| //! ``` |
| //! use tantivy::schema::*; |
| //! let mut schema_builder = Schema::builder(); |
| //! let num_stars_options = NumericOptions::default() |
| //! .set_stored() |
| //! .set_indexed(); |
| //! schema_builder.add_u64_field("num_stars", num_stars_options); |
| //! let schema = schema_builder.build(); |
| //! ``` |
| //! |
| //! Just like for Text fields (see above), |
| //! setting the field as stored defines whether the field will be |
| //! returned when [`Searcher::doc()`](crate::Searcher::doc) is called, |
| //! and setting the field as indexed means that we will be able perform queries such as |
| //! `num_stars:10`. Note that unlike text fields, numeric fields can only be indexed in one way for |
| //! the moment. |
| //! |
| //! ### Shortcuts |
| //! |
| //! |
| //! For convenience, it is possible to define your field indexing options by combining different |
| //! flags using the `|` operator. |
| //! |
| //! For instance, a schema containing the two fields defined in the example above could be |
| //! rewritten: |
| //! |
| //! ``` |
| //! use tantivy::schema::*; |
| //! let mut schema_builder = Schema::builder(); |
| //! schema_builder.add_u64_field("num_stars", INDEXED | STORED); |
| //! schema_builder.add_text_field("title", TEXT | STORED); |
| //! let schema = schema_builder.build(); |
| //! ``` |
| //! |
| //! ### Fast fields |
| //! This functionality is somewhat similar to Lucene's `DocValues`. |
| //! |
| //! Fields that are indexed as [`FAST`] will be stored in a special data structure that will |
| //! make it possible to access the value given the doc id rapidly. This is useful if the value |
| //! of the field is required during scoring or collection for instance. |
| //! |
| //! ``` |
| //! use tantivy::schema::*; |
| //! let mut schema_builder = Schema::builder(); |
| //! schema_builder.add_u64_field("population", STORED | FAST); |
| //! schema_builder.add_text_field("zip_code", STRING | FAST); |
| //! let schema = schema_builder.build(); |
| //! ``` |
| |
| </span><span class="kw">mod </span>document; |
| <span class="kw">mod </span>facet; |
| <span class="kw">mod </span>facet_options; |
| <span class="kw">mod </span>schema; |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>term; |
| |
| <span class="kw">mod </span>field_entry; |
| <span class="kw">mod </span>field_type; |
| <span class="kw">mod </span>field_value; |
| |
| <span class="kw">mod </span>bytes_options; |
| <span class="kw">mod </span>date_time_options; |
| <span class="kw">mod </span>field; |
| <span class="kw">mod </span>flags; |
| <span class="kw">mod </span>index_record_option; |
| <span class="kw">mod </span>ip_options; |
| <span class="kw">mod </span>json_object_options; |
| <span class="kw">mod </span>named_field_document; |
| <span class="kw">mod </span>numeric_options; |
| <span class="kw">mod </span>text_options; |
| <span class="kw">mod </span>value; |
| |
| <span class="kw">pub use </span><span class="self">self</span>::bytes_options::BytesOptions; |
| <span class="kw">pub use </span><span class="self">self</span>::date_time_options::{DateOptions, DatePrecision}; |
| <span class="kw">pub use </span><span class="self">self</span>::document::Document; |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="self">self</span>::facet::FACET_SEP_BYTE; |
| <span class="kw">pub use </span><span class="self">self</span>::facet::{Facet, FacetParseError}; |
| <span class="kw">pub use </span><span class="self">self</span>::facet_options::FacetOptions; |
| <span class="kw">pub use </span><span class="self">self</span>::field::Field; |
| <span class="kw">pub use </span><span class="self">self</span>::field_entry::FieldEntry; |
| <span class="kw">pub use </span><span class="self">self</span>::field_type::{FieldType, Type}; |
| <span class="kw">pub use </span><span class="self">self</span>::field_value::FieldValue; |
| <span class="kw">pub use </span><span class="self">self</span>::flags::{FAST, INDEXED, STORED}; |
| <span class="kw">pub use </span><span class="self">self</span>::index_record_option::IndexRecordOption; |
| <span class="kw">pub use </span><span class="self">self</span>::ip_options::{IntoIpv6Addr, IpAddrOptions}; |
| <span class="kw">pub use </span><span class="self">self</span>::json_object_options::JsonObjectOptions; |
| <span class="kw">pub use </span><span class="self">self</span>::named_field_document::NamedFieldDocument; |
| <span class="kw">pub use </span><span class="self">self</span>::numeric_options::NumericOptions; |
| <span class="attribute">#[allow(deprecated)] |
| </span><span class="kw">pub use </span><span class="self">self</span>::numeric_options::{Cardinality, IntOptions}; |
| <span class="kw">pub use </span><span class="self">self</span>::schema::{DocParsingError, Schema, SchemaBuilder}; |
| <span class="kw">pub use </span><span class="self">self</span>::term::Term; |
| <span class="kw">pub use </span><span class="self">self</span>::text_options::{TextFieldIndexing, TextOptions, STRING, TEXT}; |
| <span class="kw">pub use </span><span class="self">self</span>::value::Value; |
| |
| <span class="doccomment">/// Validator for a potential `field_name`. |
| /// Returns true if the name can be use for a field name. |
| /// |
| /// A field name can be any character, must have at least one character |
| /// and must not start with a `-`. |
| </span><span class="kw">pub fn </span>is_valid_field_name(field_name: <span class="kw-2">&</span>str) -> bool { |
| !field_name.is_empty() && !field_name.starts_with(<span class="string">'-'</span>) |
| } |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>tests { |
| |
| <span class="kw">use </span><span class="kw">super</span>::is_valid_field_name; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_is_valid_name() { |
| <span class="macro">assert!</span>(is_valid_field_name(<span class="string">"シャボン玉"</span>)); |
| <span class="macro">assert!</span>(!is_valid_field_name(<span class="string">"-fieldname"</span>)); |
| <span class="macro">assert!</span>(!is_valid_field_name(<span class="string">""</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> |
