| <!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="API documentation for the Rust `tantivy_common` crate."><meta name="keywords" content="rust, rustlang, rust-lang, tantivy_common"><title>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="../crates.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 mod crate"><!--[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">☰</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="#">Crate tantivy_common</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.4.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section></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">Crate <a class="mod" href="#">tantivy_common</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/lib.rs.html#1-171">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.AntiCallToken.html" title="tantivy_common::AntiCallToken struct">AntiCallToken</a></div><div class="item-right docblock-short">Struct used to prevent from calling |
| <a href="trait.TerminatingWrite.html#tymethod.terminate_ref"><code>terminate_ref</code></a> directly</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.BitSet.html" title="tantivy_common::BitSet struct">BitSet</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CountingWriter.html" title="tantivy_common::CountingWriter struct">CountingWriter</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ReadOnlyBitSet.html" title="tantivy_common::ReadOnlyBitSet struct">ReadOnlyBitSet</a></div><div class="item-right docblock-short">Serialized BitSet.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TinySet.html" title="tantivy_common::TinySet struct">TinySet</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TinySetIterator.html" title="tantivy_common::TinySetIterator struct">TinySetIterator</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.VInt.html" title="tantivy_common::VInt struct">VInt</a></div><div class="item-right docblock-short">Wrapper over a <code>u64</code> that serializes as a variable int.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.VIntU128.html" title="tantivy_common::VIntU128 struct">VIntU128</a></div><div class="item-right docblock-short">Wrapper over a <code>u128</code> that serializes as a variable int.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Endianness.html" title="tantivy_common::Endianness enum">Endianness</a></div><div class="item-right docblock-short">Defines little-endian serialization.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.BinarySerializable.html" title="tantivy_common::BinarySerializable trait">BinarySerializable</a></div><div class="item-right docblock-short">Trait for a simple binary serialization.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.DeserializeFrom.html" title="tantivy_common::DeserializeFrom trait">DeserializeFrom</a></div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.FixedSize.html" title="tantivy_common::FixedSize trait">FixedSize</a></div><div class="item-right docblock-short"><code>FixedSize</code> marks a <code>BinarySerializable</code> as |
| always serializing to the same size.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.HasLen.html" title="tantivy_common::HasLen trait">HasLen</a></div><div class="item-right docblock-short">Has length trait</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.TerminatingWrite.html" title="tantivy_common::TerminatingWrite trait">TerminatingWrite</a></div><div class="item-right docblock-short">Trait used to indicate when no more write need to be done on a writer</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.deserialize_vint_u128.html" title="tantivy_common::deserialize_vint_u128 fn">deserialize_vint_u128</a></div><div class="item-right docblock-short">Deserializes a u128 number</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.f64_to_u64.html" title="tantivy_common::f64_to_u64 fn">f64_to_u64</a></div><div class="item-right docblock-short">Maps a <code>f64</code> to <code>u64</code></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.i64_to_u64.html" title="tantivy_common::i64_to_u64 fn">i64_to_u64</a></div><div class="item-right docblock-short">Maps a <code>i64</code> to <code>u64</code></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.intersect_bitsets.html" title="tantivy_common::intersect_bitsets fn">intersect_bitsets</a></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.read_u32_vint.html" title="tantivy_common::read_u32_vint fn">read_u32_vint</a></div><div class="item-right docblock-short">Reads a vint <code>u32</code> from a buffer, and |
| consumes its payload data.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.read_u32_vint_no_advance.html" title="tantivy_common::read_u32_vint_no_advance fn">read_u32_vint_no_advance</a></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.serialize_vint_u32.html" title="tantivy_common::serialize_vint_u32 fn">serialize_vint_u32</a></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.serialize_vint_u128.html" title="tantivy_common::serialize_vint_u128 fn">serialize_vint_u128</a></div><div class="item-right docblock-short">Variable int serializes a u128 number</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.u64_to_f64.html" title="tantivy_common::u64_to_f64 fn">u64_to_f64</a></div><div class="item-right docblock-short">Reverse the mapping given by <a href="fn.f64_to_u64.html" title="f64_to_u64()"><code>f64_to_u64()</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.u64_to_i64.html" title="tantivy_common::u64_to_i64 fn">u64_to_i64</a></div><div class="item-right docblock-short">Reverse the mapping given by <a href="fn.i64_to_u64.html" title="i64_to_u64()"><code>i64_to_u64()</code></a>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.write_u32_vint.html" title="tantivy_common::write_u32_vint fn">write_u32_vint</a></div><div class="item-right docblock-short">Write a <code>u32</code> as a vint payload.</div></div></div></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> |
