Struct ScalarPrimitive

pub struct ScalarPrimitive<C: Curve> { /* private fields */ }

Generic scalar type with primitive 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.

serde support

When the optional serde feature of this create is enabled, [Serialize] and [Deserialize] impls are provided for this type.

The serialization is a fixed-width big endian encoding. When used with textual formats, the binary data is encoded as hexadecimal.

Implementations

impl<C> ScalarPrimitive<C>

where C: Curve,

pub const ZERO: Self = _

Zero scalar.

pub const ONE: Self = _

Multiplicative identity.

pub const MODULUS: C::Uint = C::ORDER

Scalar modulus.

pub fn random(rng: &mut impl CryptoRngCore) -> Self

Generate a random ScalarPrimitive.

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

Create a new scalar from Curve::Uint.

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

Decode ScalarPrimitive from a serialized field element

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

Decode ScalarPrimitive from a big 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 ScalarPrimitive value equal to zero?

pub fn is_even(&self) -> Choice

Is this ScalarPrimitive value even?

pub fn is_odd(&self) -> Choice

Is this ScalarPrimitive value odd?

pub fn to_bytes(&self) -> FieldBytes<C>

Encode ScalarPrimitive as a serialized field element.

pub fn to_uint(&self) -> C::Uint

Convert to a C::Uint.

Trait Implementations

impl<C> Add<&ScalarPrimitive<C>> for ScalarPrimitive<C>

where C: Curve,

type Output = ScalarPrimitive<C>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<C> Add for ScalarPrimitive<C>

where C: Curve,

type Output = ScalarPrimitive<C>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<C> AddAssign<&ScalarPrimitive<C>> for ScalarPrimitive<C>

where C: Curve,

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

Performs the += operation.

impl<C> AddAssign for ScalarPrimitive<C>

where C: Curve,

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<C> AsRef<[Limb]> for ScalarPrimitive<C>

where C: Curve,

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

Converts this type into a shared reference of the (usually inferred) input type.

impl<C: Clone + Curve> Clone for ScalarPrimitive<C>

where C::Uint: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> ConditionallySelectable for ScalarPrimitive<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 ScalarPrimitive<C>

where C: Curve,

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

Determine if two items are equal.

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

Determine if two items are NOT equal.

impl<C> ConstantTimeGreater for ScalarPrimitive<C>

where C: Curve,

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

Determine whether self > other.

impl<C> ConstantTimeLess for ScalarPrimitive<C>

where C: Curve,

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

Determine whether self < other.

impl<C: Debug + Curve> Debug for ScalarPrimitive<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 ScalarPrimitive<C>

where C::Uint: Default,

fn default() -> ScalarPrimitive<C>

Returns the “default value” for a type.

impl<C> Display for ScalarPrimitive<C>

where C: Curve,

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

Formats the value using the given formatter.

impl<C> From<&NonZeroScalar<C>> for ScalarPrimitive<C>

where C: CurveArithmetic,

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

Converts to this type from the input type.

impl<C> From<NonZeroScalar<C>> for ScalarPrimitive<C>

where C: CurveArithmetic,

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

Converts to this type from the input type.

impl<C> From<u64> for ScalarPrimitive<C>

where C: Curve,

fn from(n: u64) -> Self

Converts to this type from the input type.

impl<C> FromStr for ScalarPrimitive<C>

where C: Curve,

type Err = Error

The associated error which can be returned from parsing.

fn from_str(hex: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl<C> FromUintUnchecked for ScalarPrimitive<C>

where C: Curve,

type Uint = <C as Curve>::Uint

Unsigned integer type (i.e. Curve::Uint)

fn from_uint_unchecked(uint: C::Uint) -> Self

Instantiate scalar from an unsigned integer without checking whether the value overflows the field modulus.

impl<C> IsHigh for ScalarPrimitive<C>

where C: Curve,

fn is_high(&self) -> Choice

Is this scalar greater than or equal to n / 2?

impl<C> LowerHex for ScalarPrimitive<C>

where C: Curve,

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

Formats the value using the given formatter.

impl<C> Neg for &ScalarPrimitive<C>

where C: Curve,

type Output = ScalarPrimitive<C>

The resulting type after applying the - operator.

fn neg(self) -> ScalarPrimitive<C>

Performs the unary - operation.

impl<C> Neg for ScalarPrimitive<C>

where C: Curve,

type Output = ScalarPrimitive<C>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<C> Ord for ScalarPrimitive<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

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<C> PartialEq for ScalarPrimitive<C>

where C: Curve,

fn eq(&self, other: &Self) -> 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<C> PartialOrd for ScalarPrimitive<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

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<C> ShrAssign<usize> for ScalarPrimitive<C>

where C: Curve,

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl<C> Sub<&ScalarPrimitive<C>> for ScalarPrimitive<C>

where C: Curve,

type Output = ScalarPrimitive<C>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<C> Sub for ScalarPrimitive<C>

where C: Curve,

type Output = ScalarPrimitive<C>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<C> SubAssign<&ScalarPrimitive<C>> for ScalarPrimitive<C>

where C: Curve,

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

Performs the -= operation.

impl<C> SubAssign for ScalarPrimitive<C>

where C: Curve,

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<C> UpperHex for ScalarPrimitive<C>

where C: Curve,

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

Formats the value using the given formatter.

impl<C: Copy + Curve> Copy for ScalarPrimitive<C>

where C::Uint: Copy,

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

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