blob: fef535366b040bc6a272167636a71d5a53befc17 [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/schema/ip_options.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>ip_options.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>
</pre><pre class="rust"><code><span class="kw">use </span>std::net::{IpAddr, Ipv6Addr};
<span class="kw">use </span>std::ops::BitOr;
<span class="kw">use </span>serde::{Deserialize, Serialize};
<span class="kw">use </span><span class="kw">super</span>::flags::{FastFlag, IndexedFlag, SchemaFlagList, StoredFlag};
<span class="kw">use </span><span class="kw">super</span>::Cardinality;
<span class="doccomment">/// Trait to convert into an Ipv6Addr.
</span><span class="kw">pub trait </span>IntoIpv6Addr {
<span class="doccomment">/// Consumes the object and returns an Ipv6Addr.
</span><span class="kw">fn </span>into_ipv6_addr(<span class="self">self</span>) -&gt; Ipv6Addr;
}
<span class="kw">impl </span>IntoIpv6Addr <span class="kw">for </span>IpAddr {
<span class="kw">fn </span>into_ipv6_addr(<span class="self">self</span>) -&gt; Ipv6Addr {
<span class="kw">match </span><span class="self">self </span>{
IpAddr::V4(addr) =&gt; addr.to_ipv6_mapped(),
IpAddr::V6(addr) =&gt; addr,
}
}
}
<span class="doccomment">/// Define how an ip field should be handled by tantivy.
</span><span class="attribute">#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Default)]
</span><span class="kw">pub struct </span>IpAddrOptions {
<span class="attribute">#[serde(skip_serializing_if = <span class="string">&quot;Option::is_none&quot;</span>)]
</span>fast: <span class="prelude-ty">Option</span>&lt;Cardinality&gt;,
stored: bool,
indexed: bool,
fieldnorms: bool,
}
<span class="kw">impl </span>IpAddrOptions {
<span class="doccomment">/// Returns true iff the value is a fast field.
</span><span class="kw">pub fn </span>is_fast(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.fast.is_some()
}
<span class="doccomment">/// Returns `true` if the ip address should be stored in the doc store.
</span><span class="kw">pub fn </span>is_stored(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.stored
}
<span class="doccomment">/// Returns true iff the value is indexed and therefore searchable.
</span><span class="kw">pub fn </span>is_indexed(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.indexed
}
<span class="doccomment">/// Returns true if and only if the value is normed.
</span><span class="kw">pub fn </span>fieldnorms(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.fieldnorms
}
<span class="doccomment">/// Returns the cardinality of the fastfield.
///
/// If the field has not been declared as a fastfield, then
/// the method returns None.
</span><span class="kw">pub fn </span>get_fastfield_cardinality(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Cardinality&gt; {
<span class="self">self</span>.fast
}
<span class="doccomment">/// Set the field as normed.
///
/// Setting an integer as normed will generate
/// the fieldnorm data for it.
</span><span class="attribute">#[must_use]
</span><span class="kw">pub fn </span>set_fieldnorms(<span class="kw-2">mut </span><span class="self">self</span>) -&gt; <span class="self">Self </span>{
<span class="self">self</span>.fieldnorms = <span class="bool-val">true</span>;
<span class="self">self
</span>}
<span class="doccomment">/// Sets the field as stored
</span><span class="attribute">#[must_use]
</span><span class="kw">pub fn </span>set_stored(<span class="kw-2">mut </span><span class="self">self</span>) -&gt; <span class="self">Self </span>{
<span class="self">self</span>.stored = <span class="bool-val">true</span>;
<span class="self">self
</span>}
<span class="doccomment">/// Set the field as indexed.
///
/// Setting an ip address as indexed will generate
/// a posting list for each value taken by the ip address.
/// Ips are normalized to IpV6.
///
/// This is required for the field to be searchable.
</span><span class="attribute">#[must_use]
</span><span class="kw">pub fn </span>set_indexed(<span class="kw-2">mut </span><span class="self">self</span>) -&gt; <span class="self">Self </span>{
<span class="self">self</span>.indexed = <span class="bool-val">true</span>;
<span class="self">self
</span>}
<span class="doccomment">/// Set the field as a fast field.
///
/// Fast fields are designed for random access.
/// Access time are similar to a random lookup in an array.
/// If more than one value is associated with a fast field, only the last one is
/// kept.
</span><span class="attribute">#[must_use]
</span><span class="kw">pub fn </span>set_fast(<span class="kw-2">mut </span><span class="self">self</span>, cardinality: Cardinality) -&gt; <span class="self">Self </span>{
<span class="self">self</span>.fast = <span class="prelude-val">Some</span>(cardinality);
<span class="self">self
</span>}
}
<span class="kw">impl </span>From&lt;()&gt; <span class="kw">for </span>IpAddrOptions {
<span class="kw">fn </span>from(<span class="kw">_</span>: ()) -&gt; IpAddrOptions {
IpAddrOptions::default()
}
}
<span class="kw">impl </span>From&lt;FastFlag&gt; <span class="kw">for </span>IpAddrOptions {
<span class="kw">fn </span>from(<span class="kw">_</span>: FastFlag) -&gt; <span class="self">Self </span>{
IpAddrOptions {
fieldnorms: <span class="bool-val">false</span>,
indexed: <span class="bool-val">false</span>,
stored: <span class="bool-val">false</span>,
fast: <span class="prelude-val">Some</span>(Cardinality::SingleValue),
}
}
}
<span class="kw">impl </span>From&lt;StoredFlag&gt; <span class="kw">for </span>IpAddrOptions {
<span class="kw">fn </span>from(<span class="kw">_</span>: StoredFlag) -&gt; <span class="self">Self </span>{
IpAddrOptions {
fieldnorms: <span class="bool-val">false</span>,
indexed: <span class="bool-val">false</span>,
stored: <span class="bool-val">true</span>,
fast: <span class="prelude-val">None</span>,
}
}
}
<span class="kw">impl </span>From&lt;IndexedFlag&gt; <span class="kw">for </span>IpAddrOptions {
<span class="kw">fn </span>from(<span class="kw">_</span>: IndexedFlag) -&gt; <span class="self">Self </span>{
IpAddrOptions {
fieldnorms: <span class="bool-val">true</span>,
indexed: <span class="bool-val">true</span>,
stored: <span class="bool-val">false</span>,
fast: <span class="prelude-val">None</span>,
}
}
}
<span class="kw">impl</span>&lt;T: Into&lt;IpAddrOptions&gt;&gt; BitOr&lt;T&gt; <span class="kw">for </span>IpAddrOptions {
<span class="kw">type </span>Output = IpAddrOptions;
<span class="kw">fn </span>bitor(<span class="self">self</span>, other: T) -&gt; IpAddrOptions {
<span class="kw">let </span>other = other.into();
IpAddrOptions {
fieldnorms: <span class="self">self</span>.fieldnorms | other.fieldnorms,
indexed: <span class="self">self</span>.indexed | other.indexed,
stored: <span class="self">self</span>.stored | other.stored,
fast: <span class="self">self</span>.fast.or(other.fast),
}
}
}
<span class="kw">impl</span>&lt;Head, Tail&gt; From&lt;SchemaFlagList&lt;Head, Tail&gt;&gt; <span class="kw">for </span>IpAddrOptions
<span class="kw">where
</span>Head: Clone,
Tail: Clone,
<span class="self">Self</span>: BitOr&lt;Output = <span class="self">Self</span>&gt; + From&lt;Head&gt; + From&lt;Tail&gt;,
{
<span class="kw">fn </span>from(head_tail: SchemaFlagList&lt;Head, Tail&gt;) -&gt; <span class="self">Self </span>{
<span class="self">Self</span>::from(head_tail.head) | <span class="self">Self</span>::from(head_tail.tail)
}
}
</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>