blob: 67a896d2b9d9bbbeeac2930355c6f8d5209dfb1d [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="`FixedSize` marks a `BinarySerializable` as always serializing to the same size."><meta name="keywords" content="rust, rustlang, rust-lang, FixedSize"><title>FixedSize in tantivy_common - 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_common/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../tantivy_common/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">FixedSize</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-consts">Required Associated Constants</a></h3><ul class="block"><li><a href="#associatedconstant.SIZE_IN_BYTES">SIZE_IN_BYTES</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-FixedSize-for-()">()</a></li><li><a href="#impl-FixedSize-for-(Left%2C%20Right)">(Left, Right)</a></li><li><a href="#impl-FixedSize-for-bool">bool</a></li><li><a href="#impl-FixedSize-for-f32">f32</a></li><li><a href="#impl-FixedSize-for-f64">f64</a></li><li><a href="#impl-FixedSize-for-i64">i64</a></li><li><a href="#impl-FixedSize-for-u128">u128</a></li><li><a href="#impl-FixedSize-for-u16">u16</a></li><li><a href="#impl-FixedSize-for-u32">u32</a></li><li><a href="#impl-FixedSize-for-u64">u64</a></li><li><a href="#impl-FixedSize-for-u8">u8</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tantivy_common</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_common</a>::<wbr><a class="trait" href="#">FixedSize</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_common/serialize.rs.html#32-34">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 FixedSize: <a class="trait" href="trait.BinarySerializable.html" title="trait tantivy_common::BinarySerializable">BinarySerializable</a> {
const <a href="#associatedconstant.SIZE_IN_BYTES" class="constant">SIZE_IN_BYTES</a>: usize;
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>FixedSize</code> marks a <code>BinarySerializable</code> as
always serializing to the same size.</p>
</div></details><h2 id="required-associated-consts" class="small-section-header">Required Associated Constants<a href="#required-associated-consts" class="anchor"></a></h2><div class="methods"><section id="associatedconstant.SIZE_IN_BYTES" class="method has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#33">source</a><h4 class="code-header">const <a href="#associatedconstant.SIZE_IN_BYTES" class="constant">SIZE_IN_BYTES</a>: usize</h4></section></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-FixedSize-for-()" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#45-47">source</a><a href="#impl-FixedSize-for-()" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.FixedSize.html" title="trait tantivy_common::FixedSize">FixedSize</a> for ()</h3></section></summary><div class="impl-items"><section id="associatedconstant.SIZE_IN_BYTES-1" class="associatedconstant trait-impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#46">source</a><a href="#associatedconstant.SIZE_IN_BYTES-1" class="anchor"></a><h4 class="code-header">const <a href="#associatedconstant.SIZE_IN_BYTES" class="constant">SIZE_IN_BYTES</a>: usize = 0usize</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FixedSize-for-(Left%2C%20Right)" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#77-81">source</a><a href="#impl-FixedSize-for-(Left%2C%20Right)" class="anchor"></a><h3 class="code-header">impl&lt;Left:&nbsp;<a class="trait" href="trait.BinarySerializable.html" title="trait tantivy_common::BinarySerializable">BinarySerializable</a> + <a class="trait" href="trait.FixedSize.html" title="trait tantivy_common::FixedSize">FixedSize</a>, Right:&nbsp;<a class="trait" href="trait.BinarySerializable.html" title="trait tantivy_common::BinarySerializable">BinarySerializable</a> + <a class="trait" href="trait.FixedSize.html" title="trait tantivy_common::FixedSize">FixedSize</a>&gt; <a class="trait" href="trait.FixedSize.html" title="trait tantivy_common::FixedSize">FixedSize</a> for (Left, Right)</h3></section></summary><div class="impl-items"><section id="associatedconstant.SIZE_IN_BYTES-2" class="associatedconstant trait-impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#80">source</a><a href="#associatedconstant.SIZE_IN_BYTES-2" class="anchor"></a><h4 class="code-header">const <a href="#associatedconstant.SIZE_IN_BYTES" class="constant">SIZE_IN_BYTES</a>: usize = _</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FixedSize-for-u32" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#93-95">source</a><a href="#impl-FixedSize-for-u32" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.FixedSize.html" title="trait tantivy_common::FixedSize">FixedSize</a> for u32</h3></section></summary><div class="impl-items"><section id="associatedconstant.SIZE_IN_BYTES-3" class="associatedconstant trait-impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#94">source</a><a href="#associatedconstant.SIZE_IN_BYTES-3" class="anchor"></a><h4 class="code-header">const <a href="#associatedconstant.SIZE_IN_BYTES" class="constant">SIZE_IN_BYTES</a>: usize = 4usize</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FixedSize-for-u16" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#107-109">source</a><a href="#impl-FixedSize-for-u16" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.FixedSize.html" title="trait tantivy_common::FixedSize">FixedSize</a> for u16</h3></section></summary><div class="impl-items"><section id="associatedconstant.SIZE_IN_BYTES-4" class="associatedconstant trait-impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#108">source</a><a href="#associatedconstant.SIZE_IN_BYTES-4" class="anchor"></a><h4 class="code-header">const <a href="#associatedconstant.SIZE_IN_BYTES" class="constant">SIZE_IN_BYTES</a>: usize = 2usize</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FixedSize-for-u64" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#120-122">source</a><a href="#impl-FixedSize-for-u64" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.FixedSize.html" title="trait tantivy_common::FixedSize">FixedSize</a> for u64</h3></section></summary><div class="impl-items"><section id="associatedconstant.SIZE_IN_BYTES-5" class="associatedconstant trait-impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#121">source</a><a href="#associatedconstant.SIZE_IN_BYTES-5" class="anchor"></a><h4 class="code-header">const <a href="#associatedconstant.SIZE_IN_BYTES" class="constant">SIZE_IN_BYTES</a>: usize = 8usize</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FixedSize-for-u128" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#133-135">source</a><a href="#impl-FixedSize-for-u128" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.FixedSize.html" title="trait tantivy_common::FixedSize">FixedSize</a> for u128</h3></section></summary><div class="impl-items"><section id="associatedconstant.SIZE_IN_BYTES-6" class="associatedconstant trait-impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#134">source</a><a href="#associatedconstant.SIZE_IN_BYTES-6" class="anchor"></a><h4 class="code-header">const <a href="#associatedconstant.SIZE_IN_BYTES" class="constant">SIZE_IN_BYTES</a>: usize = 16usize</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FixedSize-for-f32" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#146-148">source</a><a href="#impl-FixedSize-for-f32" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.FixedSize.html" title="trait tantivy_common::FixedSize">FixedSize</a> for f32</h3></section></summary><div class="impl-items"><section id="associatedconstant.SIZE_IN_BYTES-7" class="associatedconstant trait-impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#147">source</a><a href="#associatedconstant.SIZE_IN_BYTES-7" class="anchor"></a><h4 class="code-header">const <a href="#associatedconstant.SIZE_IN_BYTES" class="constant">SIZE_IN_BYTES</a>: usize = 4usize</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FixedSize-for-i64" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#159-161">source</a><a href="#impl-FixedSize-for-i64" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.FixedSize.html" title="trait tantivy_common::FixedSize">FixedSize</a> for i64</h3></section></summary><div class="impl-items"><section id="associatedconstant.SIZE_IN_BYTES-8" class="associatedconstant trait-impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#160">source</a><a href="#associatedconstant.SIZE_IN_BYTES-8" class="anchor"></a><h4 class="code-header">const <a href="#associatedconstant.SIZE_IN_BYTES" class="constant">SIZE_IN_BYTES</a>: usize = 8usize</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FixedSize-for-f64" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#172-174">source</a><a href="#impl-FixedSize-for-f64" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.FixedSize.html" title="trait tantivy_common::FixedSize">FixedSize</a> for f64</h3></section></summary><div class="impl-items"><section id="associatedconstant.SIZE_IN_BYTES-9" class="associatedconstant trait-impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#173">source</a><a href="#associatedconstant.SIZE_IN_BYTES-9" class="anchor"></a><h4 class="code-header">const <a href="#associatedconstant.SIZE_IN_BYTES" class="constant">SIZE_IN_BYTES</a>: usize = 8usize</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FixedSize-for-u8" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#185-187">source</a><a href="#impl-FixedSize-for-u8" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.FixedSize.html" title="trait tantivy_common::FixedSize">FixedSize</a> for u8</h3></section></summary><div class="impl-items"><section id="associatedconstant.SIZE_IN_BYTES-10" class="associatedconstant trait-impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#186">source</a><a href="#associatedconstant.SIZE_IN_BYTES-10" class="anchor"></a><h4 class="code-header">const <a href="#associatedconstant.SIZE_IN_BYTES" class="constant">SIZE_IN_BYTES</a>: usize = 1usize</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-FixedSize-for-bool" class="impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#206-208">source</a><a href="#impl-FixedSize-for-bool" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.FixedSize.html" title="trait tantivy_common::FixedSize">FixedSize</a> for bool</h3></section></summary><div class="impl-items"><section id="associatedconstant.SIZE_IN_BYTES-11" class="associatedconstant trait-impl has-srclink"><a class="srclink rightside" href="../src/tantivy_common/serialize.rs.html#207">source</a><a href="#associatedconstant.SIZE_IN_BYTES-11" class="anchor"></a><h4 class="code-header">const <a href="#associatedconstant.SIZE_IN_BYTES" class="constant">SIZE_IN_BYTES</a>: usize = 1usize</h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="../implementors/tantivy_common/serialize/trait.FixedSize.js" data-ignore-extern-crates="core" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="tantivy_common" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>