Struct OOption 

pub struct OOption<T>
where
    T: Cmov + Pod + Zeroable,
{
    pub value: T,
    pub is_some: bool,
}

An alternative option implementation that is easier to use in constant-time algorithms. This type is designed to be used in scenarios where you need to conditionally move between two values without leaking information about which value is present.

Fields

value: T

The underlying value of the option.

is_some: bool

A boolean flag indicating whether the option contains a value.

Implementations

impl<T> OOption<T>

where T: Cmov + Pod + Zeroable,

pub const fn new(value: T, is_some: bool) -> Self

Creates a new OOption with the given value and presence flag.

pub const fn is_some(&self) -> bool

Returns whether the option contains a value.

pub fn unwrap(&self) -> T

Returns value if is_some(), otherwise panics.

impl<T> OOption<T>

where T: Cmov + Pod + Zeroable + Default,

pub fn unwrap_or_default(&self) -> T

Returns the contained value if present, otherwise returns a default value.

Trait Implementations

impl<T> Clone for OOption<T>

where T: Cmov + Pod + Zeroable + Clone,

fn clone(&self) -> OOption<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Cmov for OOption<T>

where T: Cmov + Pod + Zeroable,

fn cmov(&mut self, other: &Self, choice: bool)

Conditionally move other into self based on choice. @Oblivious

fn cxchg(&mut self, other: &mut Self, choice: bool)

Conditionally exchange other and self based on choice. @Oblivious

fn cset(&mut self, val_false: &Self, val_true: &Self, choice: bool)

Conditionally set self to either val_false or val_true based on choice. @Oblivious

impl<T> Debug for OOption<T>

where T: Cmov + Pod + Zeroable + Debug,

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

Formats the value using the given formatter.

impl<T> Default for OOption<T>

where T: Cmov + Pod + Zeroable + Default,

fn default() -> OOption<T>

Returns the “default value” for a type.

impl<T> Ord for OOption<T>

where T: Cmov + Pod + Zeroable + Ord,

fn cmp(&self, other: &OOption<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq for OOption<T>

where T: Cmov + Pod + Zeroable + PartialEq,

fn eq(&self, other: &OOption<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialOrd for OOption<T>

where T: Cmov + Pod + Zeroable + PartialOrd,

fn partial_cmp(&self, other: &OOption<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Zeroable for OOption<T>

where T: Cmov + Pod + Zeroable + Zeroable,

fn zeroed() -> Self

Calls zeroed.

impl<T> Copy for OOption<T>

where T: Cmov + Pod + Zeroable + Copy,

impl<T> Eq for OOption<T>

where T: Cmov + Pod + Zeroable + Eq,

impl<T> StructuralPartialEq for OOption<T>

where T: Cmov + Pod + Zeroable,