Skip to main content

Choice

Struct Choice 

Source
pub struct Choice(/* private fields */);
Expand description

A boolean that can be combined and consumed without secret-dependent branching.

Internally a u8 that is always 0 (false) or 1 (true). Combine choices with the bitwise operators (&, |, ^, !); turn one into a real bool only at the end of a computation, once the result is public — that conversion is not constant time.

Implementations§

Source§

impl Choice

Source

pub fn unwrap_u8(self) -> u8

Returns the inner 0/1 byte.

Trait Implementations§

Source§

impl BitAnd for Choice

Source§

type Output = Choice

The resulting type after applying the & operator.
Source§

fn bitand(self, rhs: Choice) -> Choice

Performs the & operation. Read more
Source§

impl BitAndAssign for Choice

Source§

fn bitand_assign(&mut self, rhs: Choice)

Performs the &= operation. Read more
Source§

impl BitOr for Choice

Source§

type Output = Choice

The resulting type after applying the | operator.
Source§

fn bitor(self, rhs: Choice) -> Choice

Performs the | operation. Read more
Source§

impl BitOrAssign for Choice

Source§

fn bitor_assign(&mut self, rhs: Choice)

Performs the |= operation. Read more
Source§

impl BitXor for Choice

Source§

type Output = Choice

The resulting type after applying the ^ operator.
Source§

fn bitxor(self, rhs: Choice) -> Choice

Performs the ^ operation. Read more
Source§

impl BitXorAssign for Choice

Source§

fn bitxor_assign(&mut self, rhs: Choice)

Performs the ^= operation. Read more
Source§

impl Clone for Choice

Source§

fn clone(&self) -> Choice

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl ConditionallySelectable for Choice

Source§

fn conditional_select(a: &Choice, b: &Choice, choice: Choice) -> Choice

Returns a if choice is true, otherwise b, without a secret-dependent branch.
Source§

fn conditional_assign(&mut self, other: &Self, choice: Choice)

Sets self to other if choice is true, otherwise leaves it unchanged.
Source§

fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)

Swaps a and b if choice is true, otherwise leaves them unchanged.
Source§

impl ConstantTimeEq for Choice

Source§

fn ct_eq(&self, other: &Choice) -> Choice

Returns a Choice that is true iff self and other are equal.
Source§

fn ct_ne(&self, other: &Self) -> Choice

Returns a Choice that is true iff self and other differ.
Source§

impl Copy for Choice

Source§

impl Debug for Choice

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for Choice

Source§

fn default() -> Choice

Returns the “default value” for a type. Read more
Source§

impl From<Choice> for bool

Source§

fn from(choice: Choice) -> Self

Converts to a plain bool. Not constant time — use only on values that are no longer secret.

Source§

impl From<u8> for Choice

Source§

fn from(value: u8) -> Self

Wraps a 0/1 byte as a Choice.

Debug builds assert the input is 0 or 1. Release builds mask value & 1 so an out-of-domain byte is silently coerced to a valid Choice rather than corrupting downstream constant-time selects. (Internal callers should still keep the bit clean — the mask is a safety net, not a license to pass arbitrary bytes.)

Source§

impl Not for Choice

Source§

type Output = Choice

The resulting type after applying the ! operator.
Source§

fn not(self) -> Choice

Performs the unary ! operation. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.