blob: 76ff94ac7bc01e20b0889e7258a9a225d38b69cc [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="Montonic maps a value to u128 value space Monotonic mapping enables `PartialOrd` on u128 space without conversion to original space."><meta name="keywords" content="rust, rustlang, rust-lang, MonotonicallyMappableToU128"><title>MonotonicallyMappableToU128 in fastfield_codecs - 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="../fastfield_codecs/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="../fastfield_codecs/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">MonotonicallyMappableToU128</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.from_u128">from_u128</a></li><li><a href="#tymethod.to_u128">to_u128</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-MonotonicallyMappableToU128-for-Ipv6Addr">Ipv6Addr</a></li><li><a href="#impl-MonotonicallyMappableToU128-for-u128">u128</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In fastfield_codecs</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">fastfield_codecs</a>::<wbr><a class="trait" href="#">MonotonicallyMappableToU128</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/fastfield_codecs/monotonic_mapping_u128.rs.html#6-19">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 MonotonicallyMappableToU128: 'static + PartialOrd + Copy + Send + Sync + Debug {
fn <a href="#tymethod.to_u128" class="fnname">to_u128</a>(self) -&gt; u128;
<span class="item-spacer"></span> fn <a href="#tymethod.from_u128" class="fnname">from_u128</a>(val: u128) -&gt; Self;
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Montonic maps a value to u128 value space
Monotonic mapping enables <code>PartialOrd</code> on u128 space without conversion to original space.</p>
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.to_u128" class="method has-srclink"><a class="srclink rightside" href="../src/fastfield_codecs/monotonic_mapping_u128.rs.html#12">source</a><h4 class="code-header">fn <a href="#tymethod.to_u128" class="fnname">to_u128</a>(self) -&gt; u128</h4></section></summary><div class="docblock"><p>Converts a value to u128.</p>
<p>Internally all fast field values are encoded as u64.</p>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.from_u128" class="method has-srclink"><a class="srclink rightside" href="../src/fastfield_codecs/monotonic_mapping_u128.rs.html#18">source</a><h4 class="code-header">fn <a href="#tymethod.from_u128" class="fnname">from_u128</a>(val: u128) -&gt; Self</h4></section></summary><div class="docblock"><p>Converts a value from u128</p>
<p>Internally all fast field values are encoded as u64.
<strong>Note: To be used for converting encoded Term, Posting values.</strong></p>
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-MonotonicallyMappableToU128-for-u128" class="impl has-srclink"><a class="srclink rightside" href="../src/fastfield_codecs/monotonic_mapping_u128.rs.html#21-29">source</a><a href="#impl-MonotonicallyMappableToU128-for-u128" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.MonotonicallyMappableToU128.html" title="trait fastfield_codecs::MonotonicallyMappableToU128">MonotonicallyMappableToU128</a> for u128</h3></section></summary><div class="impl-items"><section id="method.to_u128" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/fastfield_codecs/monotonic_mapping_u128.rs.html#22-24">source</a><a href="#method.to_u128" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.to_u128" class="fnname">to_u128</a>(self) -&gt; u128</h4></section><section id="method.from_u128" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/fastfield_codecs/monotonic_mapping_u128.rs.html#26-28">source</a><a href="#method.from_u128" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.from_u128" class="fnname">from_u128</a>(val: u128) -&gt; Self</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-MonotonicallyMappableToU128-for-Ipv6Addr" class="impl has-srclink"><a class="srclink rightside" href="../src/fastfield_codecs/monotonic_mapping_u128.rs.html#31-39">source</a><a href="#impl-MonotonicallyMappableToU128-for-Ipv6Addr" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.MonotonicallyMappableToU128.html" title="trait fastfield_codecs::MonotonicallyMappableToU128">MonotonicallyMappableToU128</a> for Ipv6Addr</h3></section></summary><div class="impl-items"><section id="method.to_u128-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/fastfield_codecs/monotonic_mapping_u128.rs.html#32-34">source</a><a href="#method.to_u128-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.to_u128" class="fnname">to_u128</a>(self) -&gt; u128</h4></section><section id="method.from_u128-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/fastfield_codecs/monotonic_mapping_u128.rs.html#36-38">source</a><a href="#method.from_u128-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.from_u128" class="fnname">from_u128</a>(val: u128) -&gt; Self</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/fastfield_codecs/monotonic_mapping_u128/trait.MonotonicallyMappableToU128.js" data-ignore-extern-crates="std,core" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="fastfield_codecs" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>