97 lines
46 KiB
HTML
97 lines
46 KiB
HTML
<!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="The `CtOption<T>` type represents an optional value similar to the `Option<T>` type but is intended for use in constant time APIs."><title>CtOption in subtle - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.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.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">CtOption</a></h2></rustdoc-topbar><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="#">CtOption</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.and_then" title="and_then">and_then</a></li><li><a href="#method.expect" title="expect">expect</a></li><li><a href="#method.into_option" title="into_option">into_option</a></li><li><a href="#method.is_none" title="is_none">is_none</a></li><li><a href="#method.is_some" title="is_some">is_some</a></li><li><a href="#method.map" title="map">map</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.or_else" title="or_else">or_else</a></li><li><a href="#method.unwrap" title="unwrap">unwrap</a></li><li><a href="#method.unwrap_or" title="unwrap_or">unwrap_or</a></li><li><a href="#method.unwrap_or_else" title="unwrap_or_else">unwrap_or_else</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-CtOption%3CT%3E" title="Clone">Clone</a></li><li><a href="#impl-ConditionallySelectable-for-CtOption%3CT%3E" title="ConditionallySelectable">ConditionallySelectable</a></li><li><a href="#impl-ConstantTimeEq-for-CtOption%3CT%3E" title="ConstantTimeEq">ConstantTimeEq</a></li><li><a href="#impl-Copy-for-CtOption%3CT%3E" title="Copy">Copy</a></li><li><a href="#impl-Debug-for-CtOption%3CT%3E" title="Debug">Debug</a></li><li><a href="#impl-From%3CCtOption%3CT%3E%3E-for-Option%3CT%3E" title="From<CtOption<T>>">From<CtOption<T>></a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-CtOption%3CT%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-CtOption%3CT%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-CtOption%3CT%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-CtOption%3CT%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-CtOption%3CT%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-CtOption%3CT%3E" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-CloneToUninit-for-T" title="CloneToUninit">CloneToUninit</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></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" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">subtle</a></div><h1>Struct <span class="struct">CtOption</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#647-650">Source</a> </span></div><pre class="rust item-decl"><code>pub struct CtOption<T> { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The <code>CtOption<T></code> type represents an optional value similar to the
|
||
<a href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option"><code>Option<T></code></a> type but is intended for
|
||
use in constant time APIs.</p>
|
||
<p>Any given <code>CtOption<T></code> is either <code>Some</code> or <code>None</code>, but unlike
|
||
<code>Option<T></code> these variants are not exposed. The
|
||
<a href="struct.CtOption.html#method.is_some" title="method subtle::CtOption::is_some"><code>is_some()</code></a> method is used to determine if
|
||
the value is <code>Some</code>, and <a href="struct.CtOption.html#method.unwrap_or" title="method subtle::CtOption::unwrap_or"><code>unwrap_or()</code></a> and
|
||
<a href="struct.CtOption.html#method.unwrap_or_else" title="method subtle::CtOption::unwrap_or_else"><code>unwrap_or_else()</code></a> methods are
|
||
provided to access the underlying value. The value can also be
|
||
obtained with <a href="struct.CtOption.html#method.unwrap" title="method subtle::CtOption::unwrap"><code>unwrap()</code></a> but this will panic
|
||
if it is <code>None</code>.</p>
|
||
<p>Functions that are intended to be constant time may not produce
|
||
valid results for all inputs, such as square root and inversion
|
||
operations in finite field arithmetic. Returning an <code>Option<T></code>
|
||
from these functions makes it difficult for the caller to reason
|
||
about the result in constant time, and returning an incorrect
|
||
value burdens the caller and increases the chance of bugs.</p>
|
||
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-CtOption%3CT%3E" class="impl"><a class="src rightside" href="../src/subtle/lib.rs.html#671-818">Source</a><a href="#impl-CtOption%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../src/subtle/lib.rs.html#678-683">Source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>(value: T, is_some: <a class="struct" href="struct.Choice.html" title="struct subtle::Choice">Choice</a>) -> <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T></h4></section></summary><div class="docblock"><p>This method is used to construct a new <code>CtOption<T></code> and takes
|
||
a value of type <code>T</code>, and a <code>Choice</code> that determines whether
|
||
the optional value should be <code>Some</code> or not. If <code>is_some</code> is
|
||
false, the value will still be stored but its value is never
|
||
exposed.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.expect" class="method"><a class="src rightside" href="../src/subtle/lib.rs.html#691-695">Source</a><h4 class="code-header">pub fn <a href="#method.expect" class="fn">expect</a>(self, msg: &<a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.str.html">str</a>) -> T</h4></section></summary><div class="docblock"><p>Returns the contained value, consuming the <code>self</code> value.</p>
|
||
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
|
||
<p>Panics if the value is none with a custom panic message provided by
|
||
<code>msg</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.unwrap" class="method"><a class="src rightside" href="../src/subtle/lib.rs.html#700-704">Source</a><h4 class="code-header">pub fn <a href="#method.unwrap" class="fn">unwrap</a>(self) -> T</h4></section></summary><div class="docblock"><p>This returns the underlying value but panics if it
|
||
is not <code>Some</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.unwrap_or" class="method"><a class="src rightside" href="../src/subtle/lib.rs.html#709-714">Source</a><h4 class="code-header">pub fn <a href="#method.unwrap_or" class="fn">unwrap_or</a>(self, def: T) -> T<div class="where">where
|
||
T: <a class="trait" href="trait.ConditionallySelectable.html" title="trait subtle::ConditionallySelectable">ConditionallySelectable</a>,</div></h4></section></summary><div class="docblock"><p>This returns the underlying value if it is <code>Some</code>
|
||
or the provided value otherwise.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.unwrap_or_else" class="method"><a class="src rightside" href="../src/subtle/lib.rs.html#722-728">Source</a><h4 class="code-header">pub fn <a href="#method.unwrap_or_else" class="fn">unwrap_or_else</a><F>(self, f: F) -> T<div class="where">where
|
||
T: <a class="trait" href="trait.ConditionallySelectable.html" title="trait subtle::ConditionallySelectable">ConditionallySelectable</a>,
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> T,</div></h4></section></summary><div class="docblock"><p>This returns the underlying value if it is <code>Some</code>
|
||
or the value produced by the provided closure otherwise.</p>
|
||
<p>This operates in constant time, because the provided closure
|
||
is always called.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_some" class="method"><a class="src rightside" href="../src/subtle/lib.rs.html#732-734">Source</a><h4 class="code-header">pub fn <a href="#method.is_some" class="fn">is_some</a>(&self) -> <a class="struct" href="struct.Choice.html" title="struct subtle::Choice">Choice</a></h4></section></summary><div class="docblock"><p>Returns a true <code>Choice</code> if this value is <code>Some</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_none" class="method"><a class="src rightside" href="../src/subtle/lib.rs.html#738-740">Source</a><h4 class="code-header">pub fn <a href="#method.is_none" class="fn">is_none</a>(&self) -> <a class="struct" href="struct.Choice.html" title="struct subtle::Choice">Choice</a></h4></section></summary><div class="docblock"><p>Returns a true <code>Choice</code> if this value is <code>None</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.map" class="method"><a class="src rightside" href="../src/subtle/lib.rs.html#751-764">Source</a><h4 class="code-header">pub fn <a href="#method.map" class="fn">map</a><U, F>(self, f: F) -> <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><U><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/default/trait.Default.html" title="trait core::default::Default">Default</a> + <a class="trait" href="trait.ConditionallySelectable.html" title="trait subtle::ConditionallySelectable">ConditionallySelectable</a>,
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(T) -> U,</div></h4></section></summary><div class="docblock"><p>Returns a <code>None</code> value if the option is <code>None</code>, otherwise
|
||
returns a <code>CtOption</code> enclosing the value of the provided closure.
|
||
The closure is given the enclosed value or, if the option is
|
||
<code>None</code>, it is provided a dummy value computed using
|
||
<code>Default::default()</code>.</p>
|
||
<p>This operates in constant time, because the provided closure
|
||
is always called.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.and_then" class="method"><a class="src rightside" href="../src/subtle/lib.rs.html#774-787">Source</a><h4 class="code-header">pub fn <a href="#method.and_then" class="fn">and_then</a><U, F>(self, f: F) -> <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><U><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/default/trait.Default.html" title="trait core::default::Default">Default</a> + <a class="trait" href="trait.ConditionallySelectable.html" title="trait subtle::ConditionallySelectable">ConditionallySelectable</a>,
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(T) -> <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><U>,</div></h4></section></summary><div class="docblock"><p>Returns a <code>None</code> value if the option is <code>None</code>, otherwise
|
||
returns the result of the provided closure. The closure is
|
||
given the enclosed value or, if the option is <code>None</code>, it
|
||
is provided a dummy value computed using <code>Default::default()</code>.</p>
|
||
<p>This operates in constant time, because the provided closure
|
||
is always called.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.or_else" class="method"><a class="src rightside" href="../src/subtle/lib.rs.html#792-801">Source</a><h4 class="code-header">pub fn <a href="#method.or_else" class="fn">or_else</a><F>(self, f: F) -> <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T><div class="where">where
|
||
T: <a class="trait" href="trait.ConditionallySelectable.html" title="trait subtle::ConditionallySelectable">ConditionallySelectable</a>,
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T>,</div></h4></section></summary><div class="docblock"><p>Returns <code>self</code> if it contains a value, and otherwise returns the result of
|
||
calling <code>f</code>. The provided function <code>f</code> is always called.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_option" class="method"><a class="src rightside" href="../src/subtle/lib.rs.html#815-817">Source</a><h4 class="code-header">pub fn <a href="#method.into_option" class="fn">into_option</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></h4></section></summary><div class="docblock"><p>Convert the <code>CtOption<T></code> wrapper into an <code>Option<T></code>, depending on whether
|
||
the underlying <code>is_some</code> <code>Choice</code> was a <code>0</code> or a <code>1</code> once unwrapped.</p>
|
||
<h5 id="note"><a class="doc-anchor" href="#note">§</a>Note</h5>
|
||
<p>This function exists to avoid ending up with ugly, verbose and/or bad handled
|
||
conversions from the <code>CtOption<T></code> wraps to an <code>Option<T></code> or <code>Result<T, E></code>.
|
||
This implementation doesn’t intend to be constant-time nor try to protect the
|
||
leakage of the <code>T</code> since the <code>Option<T></code> will do it anyways.</p>
|
||
<p>It’s equivalent to the corresponding <code>From</code> impl, however this version is
|
||
friendlier for type inference.</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-CtOption%3CT%3E" class="impl"><a class="src rightside" href="../src/subtle/lib.rs.html#646">Source</a><a href="#impl-Clone-for-CtOption%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../src/subtle/lib.rs.html#646">Source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&self) -> <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T></h4></section></summary><div class='docblock'>Returns a duplicate of the value. <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.93.1/src/core/clone.rs.html#245-247">Source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-ConditionallySelectable-for-CtOption%3CT%3E" class="impl"><a class="src rightside" href="../src/subtle/lib.rs.html#820-827">Source</a><a href="#impl-ConditionallySelectable-for-CtOption%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="trait.ConditionallySelectable.html" title="trait subtle::ConditionallySelectable">ConditionallySelectable</a>> <a class="trait" href="trait.ConditionallySelectable.html" title="trait subtle::ConditionallySelectable">ConditionallySelectable</a> for <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.conditional_select" class="method trait-impl"><a class="src rightside" href="../src/subtle/lib.rs.html#821-826">Source</a><a href="#method.conditional_select" class="anchor">§</a><h4 class="code-header">fn <a href="trait.ConditionallySelectable.html#tymethod.conditional_select" class="fn">conditional_select</a>(a: &Self, b: &Self, choice: <a class="struct" href="struct.Choice.html" title="struct subtle::Choice">Choice</a>) -> Self</h4></section></summary><div class='docblock'>Select <code>a</code> or <code>b</code> according to <code>choice</code>. <a href="trait.ConditionallySelectable.html#tymethod.conditional_select">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.conditional_assign" class="method trait-impl"><a class="src rightside" href="../src/subtle/lib.rs.html#442-444">Source</a><a href="#method.conditional_assign" class="anchor">§</a><h4 class="code-header">fn <a href="trait.ConditionallySelectable.html#method.conditional_assign" class="fn">conditional_assign</a>(&mut self, other: &Self, choice: <a class="struct" href="struct.Choice.html" title="struct subtle::Choice">Choice</a>)</h4></section></summary><div class='docblock'>Conditionally assign <code>other</code> to <code>self</code>, according to <code>choice</code>. <a href="trait.ConditionallySelectable.html#method.conditional_assign">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.conditional_swap" class="method trait-impl"><a class="src rightside" href="../src/subtle/lib.rs.html#469-473">Source</a><a href="#method.conditional_swap" class="anchor">§</a><h4 class="code-header">fn <a href="trait.ConditionallySelectable.html#method.conditional_swap" class="fn">conditional_swap</a>(a: &mut Self, b: &mut Self, choice: <a class="struct" href="struct.Choice.html" title="struct subtle::Choice">Choice</a>)</h4></section></summary><div class='docblock'>Conditionally swap <code>self</code> and <code>other</code> if <code>choice == 1</code>; otherwise,
|
||
reassign both unto themselves. <a href="trait.ConditionallySelectable.html#method.conditional_swap">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-ConstantTimeEq-for-CtOption%3CT%3E" class="impl"><a class="src rightside" href="../src/subtle/lib.rs.html#829-839">Source</a><a href="#impl-ConstantTimeEq-for-CtOption%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="trait.ConstantTimeEq.html" title="trait subtle::ConstantTimeEq">ConstantTimeEq</a>> <a class="trait" href="trait.ConstantTimeEq.html" title="trait subtle::ConstantTimeEq">ConstantTimeEq</a> for <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.ct_eq" class="method trait-impl"><a class="src rightside" href="../src/subtle/lib.rs.html#833-838">Source</a><a href="#method.ct_eq" class="anchor">§</a><h4 class="code-header">fn <a href="trait.ConstantTimeEq.html#tymethod.ct_eq" class="fn">ct_eq</a>(&self, rhs: &<a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T>) -> <a class="struct" href="struct.Choice.html" title="struct subtle::Choice">Choice</a></h4></section></summary><div class="docblock"><p>Two <code>CtOption<T></code>s are equal if they are both <code>Some</code> and
|
||
their values are equal, or both <code>None</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.ct_ne" class="method trait-impl"><a class="src rightside" href="../src/subtle/lib.rs.html#284-286">Source</a><a href="#method.ct_ne" class="anchor">§</a><h4 class="code-header">fn <a href="trait.ConstantTimeEq.html#method.ct_ne" class="fn">ct_ne</a>(&self, other: &Self) -> <a class="struct" href="struct.Choice.html" title="struct subtle::Choice">Choice</a></h4></section></summary><div class='docblock'>Determine if two items are NOT equal. <a href="trait.ConstantTimeEq.html#method.ct_ne">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-CtOption%3CT%3E" class="impl"><a class="src rightside" href="../src/subtle/lib.rs.html#646">Source</a><a href="#impl-Debug-for-CtOption%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/subtle/lib.rs.html#646">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CCtOption%3CT%3E%3E-for-Option%3CT%3E" class="impl"><a class="src rightside" href="../src/subtle/lib.rs.html#652-669">Source</a><a href="#impl-From%3CCtOption%3CT%3E%3E-for-Option%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T>> for <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="../src/subtle/lib.rs.html#662-668">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(source: <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T>) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></h4></section></summary><div class="docblock"><p>Convert the <code>CtOption<T></code> wrapper into an <code>Option<T></code>, depending on whether
|
||
the underlying <code>is_some</code> <code>Choice</code> was a <code>0</code> or a <code>1</code> once unwrapped.</p>
|
||
<h5 id="note-1"><a class="doc-anchor" href="#note-1">§</a>Note</h5>
|
||
<p>This function exists to avoid ending up with ugly, verbose and/or bad handled
|
||
conversions from the <code>CtOption<T></code> wraps to an <code>Option<T></code> or <code>Result<T, E></code>.
|
||
This implementation doesn’t intend to be constant-time nor try to protect the
|
||
leakage of the <code>T</code> since the <code>Option<T></code> will do it anyways.</p>
|
||
</div></details></div></details><section id="impl-Copy-for-CtOption%3CT%3E" class="impl"><a class="src rightside" href="../src/subtle/lib.rs.html#646">Source</a><a href="#impl-Copy-for-CtOption%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T></h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-CtOption%3CT%3E" class="impl"><a href="#impl-Freeze-for-CtOption%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,</div></h3></section><section id="impl-RefUnwindSafe-for-CtOption%3CT%3E" class="impl"><a href="#impl-RefUnwindSafe-for-CtOption%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</div></h3></section><section id="impl-Send-for-CtOption%3CT%3E" class="impl"><a href="#impl-Send-for-CtOption%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-CtOption%3CT%3E" class="impl"><a href="#impl-Sync-for-CtOption%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Unpin-for-CtOption%3CT%3E" class="impl"><a href="#impl-Unpin-for-CtOption%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-CtOption%3CT%3E" class="impl"><a href="#impl-UnwindSafe-for-CtOption%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.CtOption.html" title="struct subtle::CtOption">CtOption</a><T><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,</div></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#212">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#214">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#221">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#222">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CloneToUninit-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/clone.rs.html#547">Source</a><a href="#impl-CloneToUninit-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.CloneToUninit.html" title="trait core::clone::CloneToUninit">CloneToUninit</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone_to_uninit" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/clone.rs.html#549">Source</a><a href="#method.clone_to_uninit" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit" class="fn">clone_to_uninit</a>(&self, dest: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.93.1/core/primitive.u8.html">u8</a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>clone_to_uninit</code>)</span></div></span><div class='docblock'>Performs copy-assignment from <code>self</code> to <code>dest</code>. <a href="https://doc.rust-lang.org/1.93.1/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#785">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#788">Source</a><a href="#method.from-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#767-769">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#777">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#827-829">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#831">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#834">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#811-813">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#815">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#818">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |