blob: 3af50f4770801f531b82f0faedc721cf2c5dc0e2 [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="Source of the Rust file `/root/.cargo/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/ring/src/bits.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>bits.rs - source</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="../../source-script.js"></script><script defer src="../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../ring/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../ring/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
</pre><pre class="rust"><code><span class="comment">// Copyright 2016 Brian Smith.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHORS DISCLAIM ALL WARRANTIES
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
// SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
// OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
// CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
</span><span class="kw">use </span><span class="kw">crate</span>::error;
<span class="attribute">#[derive(Clone, Copy, Debug, Eq, PartialEq, PartialOrd)]
</span><span class="kw">pub struct </span>BitLength(usize);
<span class="comment">// Lengths measured in bits, where all arithmetic is guaranteed not to
// overflow.
</span><span class="kw">impl </span>BitLength {
<span class="attribute">#[inline]
</span><span class="kw">pub const fn </span>from_usize_bits(bits: usize) -&gt; <span class="self">Self </span>{
<span class="self">Self</span>(bits)
}
<span class="attribute">#[inline]
</span><span class="kw">pub fn </span>from_usize_bytes(bytes: usize) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, error::Unspecified&gt; {
<span class="kw">let </span>bits = bytes.checked_mul(<span class="number">8</span>).ok_or(error::Unspecified)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(<span class="self">Self</span>::from_usize_bits(bits))
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
#[inline]
</span><span class="kw">pub fn </span>half_rounded_up(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="self">Self </span>{
<span class="kw">let </span>round_up = <span class="self">self</span>.<span class="number">0 </span>&amp; <span class="number">1</span>;
<span class="self">Self</span>((<span class="self">self</span>.<span class="number">0 </span>/ <span class="number">2</span>) + round_up)
}
<span class="attribute">#[inline]
</span><span class="kw">pub fn </span>as_usize_bits(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.<span class="number">0
</span>}
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
#[inline]
</span><span class="kw">pub fn </span>as_usize_bytes_rounded_up(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="comment">// Equivalent to (self.0 + 7) / 8, except with no potential for
// overflow and without branches.
// Branchless round_up = if self.0 &amp; 0b111 != 0 { 1 } else { 0 };
</span><span class="kw">let </span>round_up = ((<span class="self">self</span>.<span class="number">0 </span>&gt;&gt; <span class="number">2</span>) | (<span class="self">self</span>.<span class="number">0 </span>&gt;&gt; <span class="number">1</span>) | <span class="self">self</span>.<span class="number">0</span>) &amp; <span class="number">1</span>;
(<span class="self">self</span>.<span class="number">0 </span>/ <span class="number">8</span>) + round_up
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
#[inline]
</span><span class="kw">pub fn </span>try_sub_1(<span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;BitLength, error::Unspecified&gt; {
<span class="kw">let </span>sum = <span class="self">self</span>.<span class="number">0</span>.checked_sub(<span class="number">1</span>).ok_or(error::Unspecified)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(BitLength(sum))
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="ring" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>