Struct elliptic_curve_flow::ScalarCore

pub struct ScalarCore<C: Curve> { /* fields omitted */ }

This is supported on crate feature arithmetic only.

Generic scalar type with core functionality.

This type provides a baseline level of scalar arithmetic functionality which is always available for all curves, regardless of if they implement any arithmetic traits.

Implementations

impl<C> ScalarCore<C> where
    C: Curve, 

pub const ZERO: Self

Zero scalar.

pub const ONE: Self

Multiplicative identity.

pub const MODULUS: C::UInt

Scalar modulus.

pub fn random(rng: impl CryptoRng + RngCore) -> Self

Generate a random ScalarCore.

pub fn new(uint: C::UInt) -> CtOption<Self>

Create a new scalar from Curve::UInt.

pub fn from_be_bytes(bytes: FieldBytes<C>) -> CtOption<Self>

Decode ScalarCore from big endian bytes.

pub fn from_be_slice(slice: &[u8]) -> Result<Self>

Decode ScalarCore from a big endian byte slice.

pub fn from_le_bytes(bytes: FieldBytes<C>) -> CtOption<Self>

Decode ScalarCore from little endian bytes.

pub fn from_le_slice(slice: &[u8]) -> Result<Self>

Decode ScalarCore from a little endian byte slice.

pub fn as_uint(&self) -> &C::UInt

Borrow the inner C::UInt.

pub fn as_limbs(&self) -> &[Limb]

Borrow the inner limbs as a slice.

pub fn is_zero(&self) -> Choice

Is this ScalarCore value equal to zero?

pub fn is_even(&self) -> Choice

Is this ScalarCore value even?

pub fn is_odd(&self) -> Choice

Is this ScalarCore value odd?

pub fn to_be_bytes(self) -> FieldBytes<C>

Encode ScalarCore as big endian bytes.

pub fn to_bytes_le(self) -> FieldBytes<C>

Encode ScalarCore as little endian bytes.

Trait Implementations

impl<C> Add<&'_ ScalarCore<C>> for ScalarCore<C> where
    C: Curve, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: &Self) -> Self

Performs the + operation.

impl<C> Add<ScalarCore<C>> for ScalarCore<C> where
    C: Curve, 

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<C> AddAssign<&'_ ScalarCore<C>> for ScalarCore<C> where
    C: Curve, 

fn add_assign(&mut self, other: &Self)

Performs the += operation.

impl<C> AddAssign<ScalarCore<C>> for ScalarCore<C> where
    C: Curve, 

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<C> AsRef<[Limb]> for ScalarCore<C> where
    C: Curve, 

fn as_ref(&self) -> &[Limb]

Performs the conversion.

impl<C: Clone + Curve> Clone for ScalarCore<C> where
    C::UInt: Clone, 

fn clone(&self) -> ScalarCore<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> ConditionallySelectable for ScalarCore<C> where
    C: Curve, 

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

Select a or b according to choice.

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

Conditionally assign other to self, according to choice.

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

Conditionally swap self and other if choice == 1; otherwise, reassign both unto themselves.

impl<C> ConstantTimeEq for ScalarCore<C> where
    C: Curve, 

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

Determine if two items are equal.

impl<C> ConstantTimeGreater for ScalarCore<C> where
    C: Curve, 

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

Determine whether self > other.

impl<C> ConstantTimeLess for ScalarCore<C> where
    C: Curve, 

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

Determine whether self < other.

impl<C: Debug + Curve> Debug for ScalarCore<C> where
    C::UInt: Debug, 

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

Formats the value using the given formatter.

impl<C: Default + Curve> Default for ScalarCore<C> where
    C::UInt: Default, 

fn default() -> ScalarCore<C>

Returns the “default value” for a type.

impl<C> From<&'_ NonZeroScalar<C>> for ScalarCore<C> where
    C: Curve + ProjectiveArithmetic, 

fn from(scalar: &NonZeroScalar<C>) -> ScalarCore<C>

Performs the conversion.

impl<C> From<NonZeroScalar<C>> for ScalarCore<C> where
    C: Curve + ProjectiveArithmetic, 

fn from(scalar: NonZeroScalar<C>) -> ScalarCore<C>

Performs the conversion.

impl<C> From<u64> for ScalarCore<C> where
    C: Curve, 

fn from(n: u64) -> Self

Performs the conversion.

impl<C> Neg for ScalarCore<C> where
    C: Curve, 

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<C> Neg for &ScalarCore<C> where
    C: Curve, 

type Output = ScalarCore<C>

The resulting type after applying the - operator.

fn neg(self) -> ScalarCore<C>

Performs the unary - operation.

impl<C> Ord for ScalarCore<C> where
    C: Curve, 

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<C> PartialEq<ScalarCore<C>> for ScalarCore<C> where
    C: Curve, 

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<C> PartialOrd<ScalarCore<C>> for ScalarCore<C> where
    C: Curve, 

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<C> Sub<&'_ ScalarCore<C>> for ScalarCore<C> where
    C: Curve, 

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: &Self) -> Self

Performs the - operation.

impl<C> Sub<ScalarCore<C>> for ScalarCore<C> where
    C: Curve, 

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<C> SubAssign<&'_ ScalarCore<C>> for ScalarCore<C> where
    C: Curve, 

fn sub_assign(&mut self, other: &Self)

Performs the -= operation.

impl<C> SubAssign<ScalarCore<C>> for ScalarCore<C> where
    C: Curve, 

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<C: Copy + Curve> Copy for ScalarCore<C> where
    C::UInt: Copy, 

impl<C: Curve> DefaultIsZeroes for ScalarCore<C>

impl<C: Curve> Eq for ScalarCore<C>