blob: f07fd21a87e4f79b25f6359b127ff014a26b1144 [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="Trait for types that are allowed for fast fields: (u64, i64 and f64, bool, DateTime)."><meta name="keywords" content="rust, rustlang, rust-lang, FastValue"><title>FastValue in tantivy::fastfield - Rust</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="sidebar-items.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 trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><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><h2></h2></nav><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><h2 class="location"><a href="#">FastValue</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.to_type">to_type</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.make_zero">make_zero</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-FastValue-for-bool">bool</a></li><li><a href="#impl-FastValue-for-f64">f64</a></li><li><a href="#impl-FastValue-for-i64">i64</a></li><li><a href="#impl-FastValue-for-u64">u64</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tantivy::fastfield</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Trait <a href="../index.html">tantivy</a>::<wbr><a href="index.html">fastfield</a>::<wbr><a class="trait" href="#">FastValue</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/tantivy/fastfield/mod.rs.html#52-63">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait FastValue: <a class="trait" href="../../fastfield_codecs/monotonic_mapping/trait.MonotonicallyMappableToU64.html" title="trait fastfield_codecs::monotonic_mapping::MonotonicallyMappableToU64">MonotonicallyMappableToU64</a> + Copy + Send + Sync + PartialOrd + 'static {
fn <a href="#tymethod.to_type" class="fnname">to_type</a>() -&gt; <a class="enum" href="../schema/enum.Type.html" title="enum tantivy::schema::Type">Type</a>;
fn <a href="#method.make_zero" class="fnname">make_zero</a>() -&gt; Self { ... }
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Trait for types that are allowed for fast fields:
(u64, i64 and f64, bool, DateTime).</p>
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.to_type" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/fastfield/mod.rs.html#56">source</a><h4 class="code-header">fn <a href="#tymethod.to_type" class="fnname">to_type</a>() -&gt; <a class="enum" href="../schema/enum.Type.html" title="enum tantivy::schema::Type">Type</a></h4></section></summary><div class="docblock"><p>Returns the <code>schema::Type</code> for this FastValue.</p>
</div></details></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.make_zero" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/fastfield/mod.rs.html#60-62">source</a><h4 class="code-header">fn <a href="#method.make_zero" class="fnname">make_zero</a>() -&gt; Self</h4></section></summary><div class="docblock"><p>Build a default value. This default value is never used, so the value does not
really matter.</p>
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FastValue-for-u64" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/fastfield/mod.rs.html#65-69">source</a><a href="#impl-FastValue-for-u64" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.FastValue.html" title="trait tantivy::fastfield::FastValue">FastValue</a> for u64</h3></section></summary><div class="impl-items"><section id="method.to_type" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/fastfield/mod.rs.html#66-68">source</a><a href="#method.to_type" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.to_type" class="fnname">to_type</a>() -&gt; <a class="enum" href="../schema/enum.Type.html" title="enum tantivy::schema::Type">Type</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FastValue-for-i64" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/fastfield/mod.rs.html#71-75">source</a><a href="#impl-FastValue-for-i64" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.FastValue.html" title="trait tantivy::fastfield::FastValue">FastValue</a> for i64</h3></section></summary><div class="impl-items"><section id="method.to_type-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/fastfield/mod.rs.html#72-74">source</a><a href="#method.to_type-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.to_type" class="fnname">to_type</a>() -&gt; <a class="enum" href="../schema/enum.Type.html" title="enum tantivy::schema::Type">Type</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FastValue-for-f64" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/fastfield/mod.rs.html#77-81">source</a><a href="#impl-FastValue-for-f64" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.FastValue.html" title="trait tantivy::fastfield::FastValue">FastValue</a> for f64</h3></section></summary><div class="impl-items"><section id="method.to_type-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/fastfield/mod.rs.html#78-80">source</a><a href="#method.to_type-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.to_type" class="fnname">to_type</a>() -&gt; <a class="enum" href="../schema/enum.Type.html" title="enum tantivy::schema::Type">Type</a></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FastValue-for-bool" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/fastfield/mod.rs.html#83-87">source</a><a href="#impl-FastValue-for-bool" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.FastValue.html" title="trait tantivy::fastfield::FastValue">FastValue</a> for bool</h3></section></summary><div class="impl-items"><section id="method.to_type-3" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/fastfield/mod.rs.html#84-86">source</a><a href="#method.to_type-3" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.to_type" class="fnname">to_type</a>() -&gt; <a class="enum" href="../schema/enum.Type.html" title="enum tantivy::schema::Type">Type</a></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-FastValue-for-DateTime" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/fastfield/mod.rs.html#100-110">source</a><a href="#impl-FastValue-for-DateTime" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.FastValue.html" title="trait tantivy::fastfield::FastValue">FastValue</a> for <a class="struct" href="../struct.DateTime.html" title="struct tantivy::DateTime">DateTime</a></h3></section></div><script src="../../implementors/tantivy/fastfield/trait.FastValue.js" data-ignore-extern-crates="core" async></script></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>