Struct ConstCtOption

pub struct ConstCtOption<T> { /* private fields */ }

An equivalent of subtle::CtOption usable in a const fn context.

Implementations

impl<T> ConstCtOption<T>

pub const fn is_some(&self) -> ConstChoice

Returns a true ConstChoice if this value is Some.

pub const fn is_none(&self) -> ConstChoice

Returns a true ConstChoice if this value is None.

pub fn unwrap(self) -> T

This returns the underlying value but panics if it is not Some.

impl<const LIMBS: usize> ConstCtOption<Uint<LIMBS>>

pub const fn unwrap_or(self, def: Uint<LIMBS>) -> Uint<LIMBS>

This returns the underlying value if it is Some or the provided value otherwise.

pub const fn expect(self, msg: &str) -> Uint<LIMBS>

Returns the contained value, consuming the self value.

Panics

Panics if the value is none with a custom panic message provided by msg.

pub const fn as_int(&self) -> ConstCtOption<Int<LIMBS>>

Returns the contained value, interpreting the underlying Uint value as an Int.

impl<const LIMBS: usize> ConstCtOption<(Uint<LIMBS>, Uint<LIMBS>)>

pub const fn expect(self, msg: &str) -> (Uint<LIMBS>, Uint<LIMBS>)

Returns the contained value, consuming the self value.

Panics

Panics if the value is none with a custom panic message provided by msg.

impl<const LIMBS: usize> ConstCtOption<NonZero<Uint<LIMBS>>>

pub const fn expect(self, msg: &str) -> NonZero<Uint<LIMBS>>

Returns the contained value, consuming the self value.

Panics

Panics if the value is none with a custom panic message provided by msg.

impl<const LIMBS: usize> ConstCtOption<Odd<Uint<LIMBS>>>

pub const fn expect(self, msg: &str) -> Odd<Uint<LIMBS>>

Returns the contained value, consuming the self value.

Panics

Panics if the value is none with a custom panic message provided by msg.

impl<const LIMBS: usize> ConstCtOption<Int<LIMBS>>

pub const fn unwrap_or(self, def: Int<LIMBS>) -> Int<LIMBS>

This returns the underlying value if it is Some or the provided value otherwise.

pub const fn expect(self, msg: &str) -> Int<LIMBS>

Returns the contained value, consuming the self value.

Panics

Panics if the value is none with a custom panic message provided by msg.

impl ConstCtOption<NonZero<Limb>>

pub const fn expect(self, msg: &str) -> NonZero<Limb>

Returns the contained value, consuming the self value.

Panics

Panics if the value is none with a custom panic message provided by msg.

impl<const SAT_LIMBS: usize, const UNSAT_LIMBS: usize> ConstCtOption<SafeGcdInverter<SAT_LIMBS, UNSAT_LIMBS>>

pub const fn expect(self, msg: &str) -> SafeGcdInverter<SAT_LIMBS, UNSAT_LIMBS>

Returns the contained value, consuming the self value.

Panics

Panics if the value is none with a custom panic message provided by msg.

Trait Implementations

impl<T: Clone> Clone for ConstCtOption<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ConstCtOption<T>

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

Formats the value using the given formatter.

impl<T> From<ConstCtOption<T>> for CtOption<T>

fn from(value: ConstCtOption<T>) -> Self

Converts to this type from the input type.

impl<T> From<ConstCtOption<T>> for Option<T>

fn from(value: ConstCtOption<T>) -> Self

Converts to this type from the input type.