-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathtrait.ConstantTimeLess.html
32 lines (25 loc) · 9.81 KB
/
trait.ConstantTimeLess.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<!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="A type which can be compared in some manner and be determined to be less than another of the same type."><title>ConstantTimeLess in subtle - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="subtle" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.0 (4d91de4e4 2025-02-17)" data-channel="1.85.0" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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" title="show sidebar"></button><a class="logo-container" href="../subtle/index.html"><img src="https://doc.dalek.rs/assets/dalek-logo-clear.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../subtle/index.html"><img src="https://doc.dalek.rs/assets/dalek-logo-clear.png" alt="logo"></a><h2><a href="../subtle/index.html">subtle</a><span class="version">2.6.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Constant<wbr>Time<wbr>Less</a></h2><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.ct_lt" title="ct_lt">ct_lt</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-ConstantTimeLess-for-Ordering" title="Ordering">Ordering</a></li><li><a href="#impl-ConstantTimeLess-for-u16" title="u16">u16</a></li><li><a href="#impl-ConstantTimeLess-for-u32" title="u32">u32</a></li><li><a href="#impl-ConstantTimeLess-for-u64" title="u64">u64</a></li><li><a href="#impl-ConstantTimeLess-for-u8" title="u8">u8</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate subtle</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">subtle</a></span><h1>Trait <span class="trait">ConstantTimeLess</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/subtle/lib.rs.html#933-973">Source</a> </span></div><pre class="rust item-decl"><code>pub trait ConstantTimeLess: <a class="trait" href="trait.ConstantTimeEq.html" title="trait subtle::ConstantTimeEq">ConstantTimeEq</a> + <a class="trait" href="trait.ConstantTimeGreater.html" title="trait subtle::ConstantTimeGreater">ConstantTimeGreater</a> {
// Provided method
fn <a href="#method.ct_lt" class="fn">ct_lt</a>(&self, other: &Self) -> <a class="struct" href="struct.Choice.html" title="struct subtle::Choice">Choice</a> { ... }
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A type which can be compared in some manner and be determined to be less
than another of the same type.</p>
</div></details><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.ct_lt" class="method"><a class="src rightside" href="../src/subtle/lib.rs.html#970-972">Source</a><h4 class="code-header">fn <a href="#method.ct_lt" class="fn">ct_lt</a>(&self, other: &Self) -> <a class="struct" href="struct.Choice.html" title="struct subtle::Choice">Choice</a></h4></section></summary><div class="docblock"><p>Determine whether <code>self < other</code>.</p>
<p>The bitwise-NOT of the return value of this function should be usable to
determine if <code>self >= other</code>.</p>
<p>A default implementation is provided and implemented for the unsigned
integer types.</p>
<p>This function should execute in constant time.</p>
<h5 id="returns"><a class="doc-anchor" href="#returns">§</a>Returns</h5>
<p>A <code>Choice</code> with a set bit if <code>self < other</code>, and with no set bits
otherwise.</p>
<h5 id="example"><a class="doc-anchor" href="#example">§</a>Example</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>subtle::ConstantTimeLess;
<span class="kw">let </span>x: u8 = <span class="number">13</span>;
<span class="kw">let </span>y: u8 = <span class="number">42</span>;
<span class="kw">let </span>x_lt_y = x.ct_lt(<span class="kw-2">&</span>y);
<span class="macro">assert_eq!</span>(x_lt_y.unwrap_u8(), <span class="number">1</span>);
<span class="kw">let </span>y_lt_x = y.ct_lt(<span class="kw-2">&</span>x);
<span class="macro">assert_eq!</span>(y_lt_x.unwrap_u8(), <span class="number">0</span>);
<span class="kw">let </span>x_lt_x = x.ct_lt(<span class="kw-2">&</span>x);
<span class="macro">assert_eq!</span>(x_lt_x.unwrap_u8(), <span class="number">0</span>);</code></pre></div>
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.85.0/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-ConstantTimeLess-for-Ordering" class="impl"><a class="src rightside" href="../src/subtle/lib.rs.html#982-990">Source</a><a href="#impl-ConstantTimeLess-for-Ordering" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ConstantTimeLess.html" title="trait subtle::ConstantTimeLess">ConstantTimeLess</a> for <a class="enum" href="https://doc.rust-lang.org/1.85.0/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a></h3></section></summary><div class="impl-items"><section id="method.ct_lt-1" class="method trait-impl"><a class="src rightside" href="../src/subtle/lib.rs.html#984-989">Source</a><a href="#method.ct_lt-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.ct_lt" class="fn">ct_lt</a>(&self, other: &Self) -> <a class="struct" href="struct.Choice.html" title="struct subtle::Choice">Choice</a></h4></section></div></details><section id="impl-ConstantTimeLess-for-u8" class="impl"><a class="src rightside" href="../src/subtle/lib.rs.html#975">Source</a><a href="#impl-ConstantTimeLess-for-u8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ConstantTimeLess.html" title="trait subtle::ConstantTimeLess">ConstantTimeLess</a> for <a class="primitive" href="https://doc.rust-lang.org/1.85.0/core/primitive.u8.html">u8</a></h3></section><section id="impl-ConstantTimeLess-for-u16" class="impl"><a class="src rightside" href="../src/subtle/lib.rs.html#976">Source</a><a href="#impl-ConstantTimeLess-for-u16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ConstantTimeLess.html" title="trait subtle::ConstantTimeLess">ConstantTimeLess</a> for <a class="primitive" href="https://doc.rust-lang.org/1.85.0/core/primitive.u16.html">u16</a></h3></section><section id="impl-ConstantTimeLess-for-u32" class="impl"><a class="src rightside" href="../src/subtle/lib.rs.html#977">Source</a><a href="#impl-ConstantTimeLess-for-u32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ConstantTimeLess.html" title="trait subtle::ConstantTimeLess">ConstantTimeLess</a> for <a class="primitive" href="https://doc.rust-lang.org/1.85.0/core/primitive.u32.html">u32</a></h3></section><section id="impl-ConstantTimeLess-for-u64" class="impl"><a class="src rightside" href="../src/subtle/lib.rs.html#978">Source</a><a href="#impl-ConstantTimeLess-for-u64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ConstantTimeLess.html" title="trait subtle::ConstantTimeLess">ConstantTimeLess</a> for <a class="primitive" href="https://doc.rust-lang.org/1.85.0/core/primitive.u64.html">u64</a></h3></section><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/subtle/trait.ConstantTimeLess.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html>