blob: 3feff6ce23b043636ec0b18968cd6d7707ed4aa9 [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="Term represents the value that the token can take."><meta name="keywords" content="rust, rustlang, rust-lang, Term"><title>Term in tantivy::schema - 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 struct"><!--[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="#">Term</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.append_bytes">append_bytes</a></li><li><a href="#method.as_bool">as_bool</a></li><li><a href="#method.as_bytes">as_bytes</a></li><li><a href="#method.as_date">as_date</a></li><li><a href="#method.as_f64">as_f64</a></li><li><a href="#method.as_facet">as_facet</a></li><li><a href="#method.as_i64">as_i64</a></li><li><a href="#method.as_str">as_str</a></li><li><a href="#method.as_u64">as_u64</a></li><li><a href="#method.clear_with_type">clear_with_type</a></li><li><a href="#method.field">field</a></li><li><a href="#method.from_facet">from_facet</a></li><li><a href="#method.from_field_bool">from_field_bool</a></li><li><a href="#method.from_field_bytes">from_field_bytes</a></li><li><a href="#method.from_field_date">from_field_date</a></li><li><a href="#method.from_field_f64">from_field_f64</a></li><li><a href="#method.from_field_i64">from_field_i64</a></li><li><a href="#method.from_field_ip_addr">from_field_ip_addr</a></li><li><a href="#method.from_field_text">from_field_text</a></li><li><a href="#method.from_field_u64">from_field_u64</a></li><li><a href="#method.is_empty">is_empty</a></li><li><a href="#method.len_bytes">len_bytes</a></li><li><a href="#method.push_byte">push_byte</a></li><li><a href="#method.set_bool">set_bool</a></li><li><a href="#method.set_bytes">set_bytes</a></li><li><a href="#method.set_date">set_date</a></li><li><a href="#method.set_f64">set_f64</a></li><li><a href="#method.set_i64">set_i64</a></li><li><a href="#method.set_ip_addr">set_ip_addr</a></li><li><a href="#method.set_text">set_text</a></li><li><a href="#method.set_u64">set_u64</a></li><li><a href="#method.truncate_value_bytes">truncate_value_bytes</a></li><li><a href="#method.typ">typ</a></li><li><a href="#method.value_bytes">value_bytes</a></li><li><a href="#method.value_bytes_mut">value_bytes_mut</a></li><li><a href="#method.wrap">wrap</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-Term%3CB%3E">Clone</a></li><li><a href="#impl-Debug-for-Term%3CB%3E">Debug</a></li><li><a href="#impl-Eq-for-Term%3CB%3E">Eq</a></li><li><a href="#impl-Hash-for-Term%3CB%3E">Hash</a></li><li><a href="#impl-Ord-for-Term%3CB%3E">Ord</a></li><li><a href="#impl-PartialEq%3CTerm%3CB%3E%3E-for-Term%3CB%3E">PartialEq&lt;Term&lt;B&gt;&gt;</a></li><li><a href="#impl-PartialOrd%3CTerm%3CB%3E%3E-for-Term%3CB%3E">PartialOrd&lt;Term&lt;B&gt;&gt;</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Term%3CB%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Term%3CB%3E">Send</a></li><li><a href="#impl-Sync-for-Term%3CB%3E">Sync</a></li><li><a href="#impl-Unpin-for-Term%3CB%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Term%3CB%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Term%3CB%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Term%3CB%3E">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Term%3CB%3E">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-CallHasher-for-Term%3CB%3E">CallHasher</a></li><li><a href="#impl-Downcast-for-Term%3CB%3E">Downcast</a></li><li><a href="#impl-DowncastSync-for-Term%3CB%3E">DowncastSync</a></li><li><a href="#impl-From%3CT%3E-for-Term%3CB%3E">From&lt;T&gt;</a></li><li><a href="#impl-Fruit-for-Term%3CB%3E">Fruit</a></li><li><a href="#impl-Into%3CU%3E-for-Term%3CB%3E">Into&lt;U&gt;</a></li><li><a href="#impl-Pointable-for-Term%3CB%3E">Pointable</a></li><li><a href="#impl-ToOwned-for-Term%3CB%3E">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Term%3CB%3E">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-Term%3CB%3E">TryInto&lt;U&gt;</a></li><li><a href="#impl-VZip%3CV%3E-for-Term%3CB%3E">VZip&lt;V&gt;</a></li></ul></section><h2><a href="index.html">In tantivy::schema</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">Struct <a href="../index.html">tantivy</a>::<wbr><a href="index.html">schema</a>::<wbr><a class="struct" href="#">Term</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/schema/term.rs.html#27-28">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 struct"><code>pub struct Term&lt;B&nbsp;=&nbsp;Vec&lt;u8&gt;&gt;(_)<br><span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: AsRef&lt;[u8]&gt;</span>;</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Term represents the value that the token can take.</p>
<p>It actually wraps a <code>Vec&lt;u8&gt;</code>.</p>
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Term" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#33-214">source</a><a href="#impl-Term" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_empty" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#70-72">source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fnname">is_empty</a>(&amp;self) -&gt; bool</h4></section></summary><div class="docblock"><p>Is empty if there are no value bytes.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_field_ip_addr" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#75-79">source</a><h4 class="code-header">pub fn <a href="#method.from_field_ip_addr" class="fnname">from_field_ip_addr</a>(field: <a class="struct" href="struct.Field.html" title="struct tantivy::schema::Field">Field</a>, ip_addr: Ipv6Addr) -&gt; <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a></h4></section></summary><div class="docblock"><p>Builds a term given a field, and a <code>Ipv6Addr</code>-value</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_field_u64" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#82-84">source</a><h4 class="code-header">pub fn <a href="#method.from_field_u64" class="fnname">from_field_u64</a>(field: <a class="struct" href="struct.Field.html" title="struct tantivy::schema::Field">Field</a>, val: u64) -&gt; <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a></h4></section></summary><div class="docblock"><p>Builds a term given a field, and a <code>u64</code>-value</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_field_i64" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#87-89">source</a><h4 class="code-header">pub fn <a href="#method.from_field_i64" class="fnname">from_field_i64</a>(field: <a class="struct" href="struct.Field.html" title="struct tantivy::schema::Field">Field</a>, val: i64) -&gt; <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a></h4></section></summary><div class="docblock"><p>Builds a term given a field, and a <code>i64</code>-value</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_field_f64" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#92-94">source</a><h4 class="code-header">pub fn <a href="#method.from_field_f64" class="fnname">from_field_f64</a>(field: <a class="struct" href="struct.Field.html" title="struct tantivy::schema::Field">Field</a>, val: f64) -&gt; <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a></h4></section></summary><div class="docblock"><p>Builds a term given a field, and a <code>f64</code>-value</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_field_bool" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#97-99">source</a><h4 class="code-header">pub fn <a href="#method.from_field_bool" class="fnname">from_field_bool</a>(field: <a class="struct" href="struct.Field.html" title="struct tantivy::schema::Field">Field</a>, val: bool) -&gt; <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a></h4></section></summary><div class="docblock"><p>Builds a term given a field, and a <code>bool</code>-value</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_field_date" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#102-104">source</a><h4 class="code-header">pub fn <a href="#method.from_field_date" class="fnname">from_field_date</a>(field: <a class="struct" href="struct.Field.html" title="struct tantivy::schema::Field">Field</a>, val: <a class="struct" href="../struct.DateTime.html" title="struct tantivy::DateTime">DateTime</a>) -&gt; <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a></h4></section></summary><div class="docblock"><p>Builds a term given a field, and a <code>DateTime</code> value</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_facet" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#107-110">source</a><h4 class="code-header">pub fn <a href="#method.from_facet" class="fnname">from_facet</a>(field: <a class="struct" href="struct.Field.html" title="struct tantivy::schema::Field">Field</a>, facet: &amp;<a class="struct" href="struct.Facet.html" title="struct tantivy::schema::Facet">Facet</a>) -&gt; <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a></h4></section></summary><div class="docblock"><p>Creates a <code>Term</code> given a facet.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_field_text" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#113-115">source</a><h4 class="code-header">pub fn <a href="#method.from_field_text" class="fnname">from_field_text</a>(field: <a class="struct" href="struct.Field.html" title="struct tantivy::schema::Field">Field</a>, text: &amp;str) -&gt; <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a></h4></section></summary><div class="docblock"><p>Builds a term given a field, and a string value</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_field_bytes" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#118-120">source</a><h4 class="code-header">pub fn <a href="#method.from_field_bytes" class="fnname">from_field_bytes</a>(field: <a class="struct" href="struct.Field.html" title="struct tantivy::schema::Field">Field</a>, bytes: &amp;[u8]) -&gt; <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a></h4></section></summary><div class="docblock"><p>Builds a term bytes.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clear_with_type" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#129-132">source</a><h4 class="code-header">pub fn <a href="#method.clear_with_type" class="fnname">clear_with_type</a>(&amp;mut self, typ: <a class="enum" href="enum.Type.html" title="enum tantivy::schema::Type">Type</a>)</h4></section></summary><div class="docblock"><p>Removes the value_bytes and set the type code.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.set_u64" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#140-142">source</a><h4 class="code-header">pub fn <a href="#method.set_u64" class="fnname">set_u64</a>(&amp;mut self, val: u64)</h4></section></summary><div class="docblock"><p>Sets a u64 value in the term.</p>
<p>U64 are serialized using (8-byte) BigEndian
representation.
The use of BigEndian has the benefit of preserving
the natural order of the values.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.set_i64" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#145-147">source</a><h4 class="code-header">pub fn <a href="#method.set_i64" class="fnname">set_i64</a>(&amp;mut self, val: i64)</h4></section></summary><div class="docblock"><p>Sets a <code>i64</code> value in the term.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.set_date" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#150-152">source</a><h4 class="code-header">pub fn <a href="#method.set_date" class="fnname">set_date</a>(&amp;mut self, date: <a class="struct" href="../struct.DateTime.html" title="struct tantivy::DateTime">DateTime</a>)</h4></section></summary><div class="docblock"><p>Sets a <code>DateTime</code> value in the term.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.set_f64" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#155-157">source</a><h4 class="code-header">pub fn <a href="#method.set_f64" class="fnname">set_f64</a>(&amp;mut self, val: f64)</h4></section></summary><div class="docblock"><p>Sets a <code>f64</code> value in the term.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.set_bool" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#160-162">source</a><h4 class="code-header">pub fn <a href="#method.set_bool" class="fnname">set_bool</a>(&amp;mut self, val: bool)</h4></section></summary><div class="docblock"><p>Sets a <code>bool</code> value in the term.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.set_ip_addr" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#169-171">source</a><h4 class="code-header">pub fn <a href="#method.set_ip_addr" class="fnname">set_ip_addr</a>(&amp;mut self, val: Ipv6Addr)</h4></section></summary><div class="docblock"><p>Sets a <code>Ipv6Addr</code> value in the term.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.set_bytes" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#174-177">source</a><h4 class="code-header">pub fn <a href="#method.set_bytes" class="fnname">set_bytes</a>(&amp;mut self, bytes: &amp;[u8])</h4></section></summary><div class="docblock"><p>Sets the value of a <code>Bytes</code> field.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.set_text" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#180-182">source</a><h4 class="code-header">pub fn <a href="#method.set_text" class="fnname">set_text</a>(&amp;mut self, text: &amp;str)</h4></section></summary><div class="docblock"><p>Set the texts only, keeping the field untouched.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.truncate_value_bytes" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#185-187">source</a><h4 class="code-header">pub fn <a href="#method.truncate_value_bytes" class="fnname">truncate_value_bytes</a>(&amp;mut self, len: usize)</h4></section></summary><div class="docblock"><p>Truncates the value bytes of the term. Value and field type stays the same.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.value_bytes_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#190-192">source</a><h4 class="code-header">pub fn <a href="#method.value_bytes_mut" class="fnname">value_bytes_mut</a>(&amp;mut self) -&gt; &amp;mut [u8]</h4></section></summary><div class="docblock"><p>Returns the value bytes as mutable slice</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.len_bytes" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#195-197">source</a><h4 class="code-header">pub fn <a href="#method.len_bytes" class="fnname">len_bytes</a>(&amp;self) -&gt; usize</h4></section></summary><div class="docblock"><p>The length of the bytes.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.append_bytes" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#203-207">source</a><h4 class="code-header">pub fn <a href="#method.append_bytes" class="fnname">append_bytes</a>(&amp;mut self, bytes: &amp;[u8]) -&gt; &amp;mut [u8]</h4></section></summary><div class="docblock"><p>Appends value bytes to the Term.</p>
<p>This function returns the segment that has just been added.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.push_byte" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#211-213">source</a><h4 class="code-header">pub fn <a href="#method.push_byte" class="fnname">push_byte</a>(&amp;mut self, byte: u8)</h4></section></summary><div class="docblock"><p>Appends a single byte to the term.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Term%3CB%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#250-381">source</a><a href="#impl-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;B&gt; <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a>&lt;B&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: AsRef&lt;[u8]&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.wrap" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#254-256">source</a><h4 class="code-header">pub fn <a href="#method.wrap" class="fnname">wrap</a>(data: B) -&gt; <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a>&lt;B&gt;</h4></section></summary><div class="docblock"><p>Wraps a object holding bytes</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.typ" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#266-268">source</a><h4 class="code-header">pub fn <a href="#method.typ" class="fnname">typ</a>(&amp;self) -&gt; <a class="enum" href="enum.Type.html" title="enum tantivy::schema::Type">Type</a></h4></section></summary><div class="docblock"><p>Return the type of the term.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.field" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#271-275">source</a><h4 class="code-header">pub fn <a href="#method.field" class="fnname">field</a>(&amp;self) -&gt; <a class="struct" href="struct.Field.html" title="struct tantivy::schema::Field">Field</a></h4></section></summary><div class="docblock"><p>Returns the field.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_u64" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#281-283">source</a><h4 class="code-header">pub fn <a href="#method.as_u64" class="fnname">as_u64</a>(&amp;self) -&gt; Option&lt;u64&gt;</h4></section></summary><div class="docblock"><p>Returns the <code>u64</code> value stored in a term.</p>
<p>Returns <code>None</code> if the term is not of the u64 type, or if the term byte representation
is invalid.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_i64" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#303-305">source</a><h4 class="code-header">pub fn <a href="#method.as_i64" class="fnname">as_i64</a>(&amp;self) -&gt; Option&lt;i64&gt;</h4></section></summary><div class="docblock"><p>Returns the <code>i64</code> value stored in a term.</p>
<p>Returns <code>None</code> if the term is not of the i64 type, or if the term byte representation
is invalid.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_f64" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#311-313">source</a><h4 class="code-header">pub fn <a href="#method.as_f64" class="fnname">as_f64</a>(&amp;self) -&gt; Option&lt;f64&gt;</h4></section></summary><div class="docblock"><p>Returns the <code>f64</code> value stored in a term.</p>
<p>Returns <code>None</code> if the term is not of the f64 type, or if the term byte representation
is invalid.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_bool" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#319-321">source</a><h4 class="code-header">pub fn <a href="#method.as_bool" class="fnname">as_bool</a>(&amp;self) -&gt; Option&lt;bool&gt;</h4></section></summary><div class="docblock"><p>Returns the <code>bool</code> value stored in a term.</p>
<p>Returns <code>None</code> if the term is not of the bool type, or if the term byte representation
is invalid.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_date" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#327-329">source</a><h4 class="code-header">pub fn <a href="#method.as_date" class="fnname">as_date</a>(&amp;self) -&gt; Option&lt;<a class="struct" href="../struct.DateTime.html" title="struct tantivy::DateTime">DateTime</a>&gt;</h4></section></summary><div class="docblock"><p>Returns the <code>Date</code> value stored in a term.</p>
<p>Returns <code>None</code> if the term is not of the Date type, or if the term byte representation
is invalid.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_str" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#335-340">source</a><h4 class="code-header">pub fn <a href="#method.as_str" class="fnname">as_str</a>(&amp;self) -&gt; Option&lt;&amp;str&gt;</h4></section></summary><div class="docblock"><p>Returns the text associated with the term.</p>
<p>Returns <code>None</code> if the field is not of string type
or if the bytes are not valid utf-8.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_facet" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#346-352">source</a><h4 class="code-header">pub fn <a href="#method.as_facet" class="fnname">as_facet</a>(&amp;self) -&gt; Option&lt;<a class="struct" href="struct.Facet.html" title="struct tantivy::schema::Facet">Facet</a>&gt;</h4></section></summary><div class="docblock"><p>Returns the facet associated with the term.</p>
<p>Returns <code>None</code> if the field is not of facet type
or if the bytes are not valid utf-8.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_bytes" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#357-362">source</a><h4 class="code-header">pub fn <a href="#method.as_bytes" class="fnname">as_bytes</a>(&amp;self) -&gt; Option&lt;&amp;[u8]&gt;</h4></section></summary><div class="docblock"><p>Returns the bytes associated with the term.</p>
<p>Returns <code>None</code> if the field is not of bytes type.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.value_bytes" class="method has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#370-372">source</a><h4 class="code-header">pub fn <a href="#method.value_bytes" class="fnname">value_bytes</a>(&amp;self) -&gt; &amp;[u8]</h4></section></summary><div class="docblock"><p>Returns the serialized value of the term.
(this does not include the field.)</p>
<p>If the term is a string, its value is utf-8 encoded.
If the term is a u64, its value is encoded according
to <code>byteorder::LittleEndian</code>.</p>
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-Term%3CB%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#26">source</a><a href="#impl-Clone-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;B:&nbsp;Clone&gt; Clone for <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a>&lt;B&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: AsRef&lt;[u8]&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#26">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&amp;self) -&gt; <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a>&lt;B&gt;</h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&amp;mut self, source: &amp;Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Term%3CB%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#456-467">source</a><a href="#impl-Debug-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;B&gt; Debug for <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a>&lt;B&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: AsRef&lt;[u8]&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#459-466">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&amp;self, f: &amp;mut Formatter&lt;'_&gt;) -&gt; Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Hash-for-Term%3CB%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#242-248">source</a><a href="#impl-Hash-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;B&gt; Hash for <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a>&lt;B&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: AsRef&lt;[u8]&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.hash" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#245-247">source</a><a href="#method.hash" class="anchor"></a><h4 class="code-header">fn <a class="fnname">hash</a>&lt;H:&nbsp;Hasher&gt;(&amp;self, state: &amp;mut H)</h4></section></summary><div class='docblock'>Feeds this value into the given [<code>Hasher</code>]. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.hash_slice" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.3.0">1.3.0</span><a href="#method.hash_slice" class="anchor"></a><h4 class="code-header">fn <a class="fnname">hash_slice</a>&lt;H&gt;(data: &amp;[Self], state: &amp;mut H)<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;H: Hasher,</span></h4></section></summary><div class='docblock'>Feeds a slice of this type into the given [<code>Hasher</code>]. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Ord-for-Term%3CB%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#216-222">source</a><a href="#impl-Ord-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;B&gt; Ord for <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a>&lt;B&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: AsRef&lt;[u8]&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.cmp" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#219-221">source</a><a href="#method.cmp" class="anchor"></a><h4 class="code-header">fn <a class="fnname">cmp</a>(&amp;self, other: &amp;Self) -&gt; Ordering</h4></section></summary><div class='docblock'>This method returns an [<code>Ordering</code>] between <code>self</code> and <code>other</code>. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.max" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.21.0">1.21.0</span><a href="#method.max" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">max</a>(self, other: Self) -&gt; Self</h4></section></summary><div class='docblock'>Compares and returns the maximum of two values. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.min" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.21.0">1.21.0</span><a href="#method.min" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">min</a>(self, other: Self) -&gt; Self</h4></section></summary><div class='docblock'>Compares and returns the minimum of two values. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clamp" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.50.0">1.50.0</span><a href="#method.clamp" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clamp</a>(self, min: Self, max: Self) -&gt; Self<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: PartialOrd&lt;Self&gt;,</span></h4></section></summary><div class='docblock'>Restrict a value to a certain interval. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CTerm%3CB%3E%3E-for-Term%3CB%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#232-238">source</a><a href="#impl-PartialEq%3CTerm%3CB%3E%3E-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;B&gt; PartialEq&lt;<a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a>&lt;B&gt;&gt; for <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a>&lt;B&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: AsRef&lt;[u8]&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#235-237">source</a><a href="#method.eq" class="anchor"></a><h4 class="code-header">fn <a class="fnname">eq</a>(&amp;self, other: &amp;Self) -&gt; bool</h4></section></summary><div class='docblock'>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
by <code>==</code>. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.ne" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">ne</a>(&amp;self, other: &amp;Rhs) -&gt; bool</h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always
sufficient, and should not be overridden without very good reason. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialOrd%3CTerm%3CB%3E%3E-for-Term%3CB%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#224-230">source</a><a href="#impl-PartialOrd%3CTerm%3CB%3E%3E-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;B&gt; PartialOrd&lt;<a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a>&lt;B&gt;&gt; for <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a>&lt;B&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: AsRef&lt;[u8]&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.partial_cmp" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#227-229">source</a><a href="#method.partial_cmp" class="anchor"></a><h4 class="code-header">fn <a class="fnname">partial_cmp</a>(&amp;self, other: &amp;Self) -&gt; Option&lt;Ordering&gt;</h4></section></summary><div class='docblock'>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.lt" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.lt" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">lt</a>(&amp;self, other: &amp;Rhs) -&gt; bool</h4></section></summary><div class='docblock'>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code>&lt;</code> operator. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.le" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.le" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">le</a>(&amp;self, other: &amp;Rhs) -&gt; bool</h4></section></summary><div class='docblock'>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>&lt;=</code>
operator. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.gt" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.gt" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">gt</a>(&amp;self, other: &amp;Rhs) -&gt; bool</h4></section></summary><div class='docblock'>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>&gt;</code> operator. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ge" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.ge" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">ge</a>(&amp;self, other: &amp;Rhs) -&gt; bool</h4></section></summary><div class='docblock'>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>&gt;=</code>
operator. <a>Read more</a></div></details></div></details><section id="impl-Eq-for-Term%3CB%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/schema/term.rs.html#240">source</a><a href="#impl-Eq-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;B&gt; Eq for <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a>&lt;B&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: AsRef&lt;[u8]&gt;,</span></h3></section></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-Term%3CB%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;B&gt; RefUnwindSafe for <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a>&lt;B&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-Term%3CB%3E" class="impl has-srclink"><a href="#impl-Send-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;B&gt; Send for <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a>&lt;B&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: Send,</span></h3></section><section id="impl-Sync-for-Term%3CB%3E" class="impl has-srclink"><a href="#impl-Sync-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;B&gt; Sync for <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a>&lt;B&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: Sync,</span></h3></section><section id="impl-Unpin-for-Term%3CB%3E" class="impl has-srclink"><a href="#impl-Unpin-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;B&gt; Unpin for <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a>&lt;B&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-Term%3CB%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;B&gt; UnwindSafe for <a class="struct" href="struct.Term.html" title="struct tantivy::schema::Term">Term</a>&lt;B&gt;<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;B: UnwindSafe,</span></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-Term%3CB%3E" class="impl has-srclink"><a href="#impl-Any-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Any for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&amp;self) -&gt; TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Term%3CB%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; Borrow&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&amp;self) -&gt; &amp;T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Term%3CB%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; BorrowMut&lt;T&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&amp;mut self) -&gt; &amp;mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-CallHasher-for-Term%3CB%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/ahash/specialize.rs.html#59">source</a><a href="#impl-CallHasher-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../../ahash/specialize/trait.CallHasher.html" title="trait ahash::specialize::CallHasher">CallHasher</a> for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Hash + ?Sized,</span></h3></section></summary><div class="impl-items"><section id="method.get_hash" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/ahash/specialize.rs.html#64">source</a><a href="#method.get_hash" class="anchor"></a><h4 class="code-header">default fn <a href="../../ahash/specialize/trait.CallHasher.html#tymethod.get_hash" class="fnname">get_hash</a>&lt;H, B&gt;(value: &amp;H, build_hasher: &amp;B) -&gt; u64<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;H: Hash + ?Sized,<br>&nbsp;&nbsp;&nbsp;&nbsp;B: BuildHasher,</span></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Downcast-for-Term%3CB%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/downcast_rs/lib.rs.html#190">source</a><a href="#impl-Downcast-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../../downcast_rs/trait.Downcast.html" title="trait downcast_rs::Downcast">Downcast</a> for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Any,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_any" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/downcast_rs/lib.rs.html#191">source</a><a href="#method.into_any" class="anchor"></a><h4 class="code-header">fn <a href="../../downcast_rs/trait.Downcast.html#tymethod.into_any" class="fnname">into_any</a>(self: Box&lt;T, Global&gt;) -&gt; Box&lt;dyn Any + 'static, Global&gt;</h4></section></summary><div class='docblock'>Convert <code>Box&lt;dyn Trait&gt;</code> (where <code>Trait: Downcast</code>) to <code>Box&lt;dyn Any&gt;</code>. <code>Box&lt;dyn Any&gt;</code> can
then be further <code>downcast</code> into <code>Box&lt;ConcreteType&gt;</code> where <code>ConcreteType</code> implements <code>Trait</code>. <a href="../../downcast_rs/trait.Downcast.html#tymethod.into_any">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_any_rc" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/downcast_rs/lib.rs.html#192">source</a><a href="#method.into_any_rc" class="anchor"></a><h4 class="code-header">fn <a href="../../downcast_rs/trait.Downcast.html#tymethod.into_any_rc" class="fnname">into_any_rc</a>(self: Rc&lt;T&gt;) -&gt; Rc&lt;dyn Any + 'static&gt;</h4></section></summary><div class='docblock'>Convert <code>Rc&lt;Trait&gt;</code> (where <code>Trait: Downcast</code>) to <code>Rc&lt;Any&gt;</code>. <code>Rc&lt;Any&gt;</code> can then be
further <code>downcast</code> into <code>Rc&lt;ConcreteType&gt;</code> where <code>ConcreteType</code> implements <code>Trait</code>. <a href="../../downcast_rs/trait.Downcast.html#tymethod.into_any_rc">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_any" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/downcast_rs/lib.rs.html#193">source</a><a href="#method.as_any" class="anchor"></a><h4 class="code-header">fn <a href="../../downcast_rs/trait.Downcast.html#tymethod.as_any" class="fnname">as_any</a>(&amp;self) -&gt; &amp;(dyn Any + 'static)</h4></section></summary><div class='docblock'>Convert <code>&amp;Trait</code> (where <code>Trait: Downcast</code>) to <code>&amp;Any</code>. This is needed since Rust cannot
generate <code>&amp;Any</code>’s vtable from <code>&amp;Trait</code>’s. <a href="../../downcast_rs/trait.Downcast.html#tymethod.as_any">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_any_mut" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/downcast_rs/lib.rs.html#194">source</a><a href="#method.as_any_mut" class="anchor"></a><h4 class="code-header">fn <a href="../../downcast_rs/trait.Downcast.html#tymethod.as_any_mut" class="fnname">as_any_mut</a>(&amp;mut self) -&gt; &amp;mut (dyn Any + 'static)</h4></section></summary><div class='docblock'>Convert <code>&amp;mut Trait</code> (where <code>Trait: Downcast</code>) to <code>&amp;Any</code>. This is needed since Rust cannot
generate <code>&amp;mut Any</code>’s vtable from <code>&amp;mut Trait</code>’s. <a href="../../downcast_rs/trait.Downcast.html#tymethod.as_any_mut">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-DowncastSync-for-Term%3CB%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/downcast_rs/lib.rs.html#204">source</a><a href="#impl-DowncastSync-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../../downcast_rs/trait.DowncastSync.html" title="trait downcast_rs::DowncastSync">DowncastSync</a> for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Any + Send + Sync,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_any_arc" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/downcast_rs/lib.rs.html#205">source</a><a href="#method.into_any_arc" class="anchor"></a><h4 class="code-header">fn <a href="../../downcast_rs/trait.DowncastSync.html#tymethod.into_any_arc" class="fnname">into_any_arc</a>(self: Arc&lt;T&gt;) -&gt; Arc&lt;dyn Any + Sync + Send + 'static&gt;</h4></section></summary><div class='docblock'>Convert <code>Arc&lt;Trait&gt;</code> (where <code>Trait: Downcast</code>) to <code>Arc&lt;Any&gt;</code>. <code>Arc&lt;Any&gt;</code> can then be
further <code>downcast</code> into <code>Arc&lt;ConcreteType&gt;</code> where <code>ConcreteType</code> implements <code>Trait</code>. <a href="../../downcast_rs/trait.DowncastSync.html#tymethod.into_any_arc">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Term%3CB%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; From&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-Term%3CB%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; Into&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: From&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code>[From]&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Pointable-for-Term%3CB%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_epoch/atomic.rs.html#194">source</a><a href="#impl-Pointable-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../../crossbeam_epoch/atomic/trait.Pointable.html" title="trait crossbeam_epoch::atomic::Pointable">Pointable</a> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedconstant.ALIGN" class="associatedconstant trait-impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_epoch/atomic.rs.html#195">source</a><a href="#associatedconstant.ALIGN" class="anchor"></a><h4 class="code-header">const <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#associatedconstant.ALIGN" class="constant">ALIGN</a>: usize = mem::align_of::&lt;T&gt;()</h4></section></summary><div class='docblock'>The alignment of pointer.</div></details><details class="rustdoc-toggle" open><summary><section id="associatedtype.Init" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Init" class="anchor"></a><h4 class="code-header">type <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#associatedtype.Init" class="associatedtype">Init</a> = T</h4></section></summary><div class='docblock'>The type for initializers.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.init" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_epoch/atomic.rs.html#199">source</a><a href="#method.init" class="anchor"></a><h4 class="code-header">unsafe fn <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.init" class="fnname">init</a>(init: &lt;T as <a class="trait" href="../../crossbeam_epoch/atomic/trait.Pointable.html" title="trait crossbeam_epoch::atomic::Pointable">Pointable</a>&gt;::<a class="associatedtype" href="../../crossbeam_epoch/atomic/trait.Pointable.html#associatedtype.Init" title="type crossbeam_epoch::atomic::Pointable::Init">Init</a>) -&gt; usize</h4></section></summary><div class='docblock'>Initializes a with the given initializer. <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.init">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.deref" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_epoch/atomic.rs.html#203">source</a><a href="#method.deref" class="anchor"></a><h4 class="code-header">unsafe fn <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.deref" class="fnname">deref</a>&lt;'a&gt;(ptr: usize) -&gt; &amp;'a T</h4></section></summary><div class='docblock'>Dereferences the given pointer. <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.deref">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.deref_mut" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_epoch/atomic.rs.html#207">source</a><a href="#method.deref_mut" class="anchor"></a><h4 class="code-header">unsafe fn <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.deref_mut" class="fnname">deref_mut</a>&lt;'a&gt;(ptr: usize) -&gt; &amp;'a mut T</h4></section></summary><div class='docblock'>Mutably dereferences the given pointer. <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.deref_mut">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/crossbeam_epoch/atomic.rs.html#211">source</a><a href="#method.drop" class="anchor"></a><h4 class="code-header">unsafe fn <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.drop" class="fnname">drop</a>(ptr: usize)</h4></section></summary><div class='docblock'>Drops the object pointed to by the given pointer. <a href="../../crossbeam_epoch/atomic/trait.Pointable.html#tymethod.drop">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-Term%3CB%3E" class="impl has-srclink"><a href="#impl-ToOwned-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; ToOwned for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a class="fnname">to_owned</a>(&amp;self) -&gt; T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone_into</a>(&amp;self, target: &amp;mut T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Term%3CB%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryFrom&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: Into&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -&gt; Result&lt;T, &lt;T as TryFrom&lt;U&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Term%3CB%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;T, U&gt; TryInto&lt;U&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: TryFrom&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = &lt;U as TryFrom&lt;T&gt;&gt;::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -&gt; Result&lt;U, &lt;U as TryFrom&lt;T&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-VZip%3CV%3E-for-Term%3CB%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/ppv_lite86/types.rs.html#221">source</a><a href="#impl-VZip%3CV%3E-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;V, T&gt; <a class="trait" href="../../ppv_lite86/types/trait.VZip.html" title="trait ppv_lite86::types::VZip">VZip</a>&lt;V&gt; for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;V: <a class="trait" href="../../ppv_lite86/types/trait.MultiLane.html" title="trait ppv_lite86::types::MultiLane">MultiLane</a>&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><section id="method.vzip" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/ppv_lite86/types.rs.html#226">source</a><a href="#method.vzip" class="anchor"></a><h4 class="code-header">fn <a href="../../ppv_lite86/types/trait.VZip.html#tymethod.vzip" class="fnname">vzip</a>(self) -&gt; V</h4></section></div></details><section id="impl-Fruit-for-Term%3CB%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tantivy/collector/mod.rs.html#122">source</a><a href="#impl-Fruit-for-Term%3CB%3E" class="anchor"></a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="../collector/trait.Fruit.html" title="trait tantivy::collector::Fruit">Fruit</a> for T<span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: Send + <a class="trait" href="../../downcast_rs/trait.Downcast.html" title="trait downcast_rs::Downcast">Downcast</a>,</span></h3></section></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>