Struct ScalarValue 

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

Integer values within the range of a given Curve’s scalar modulus.

This type provides a baseline level of scalar arithmetic functionality which is always available for all curves.

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> ScalarValue<C>

where C: Curve,

pub const ZERO: Self

Zero scalar.

pub const ONE: Self

Multiplicative identity.

pub const MODULUS: Odd<C::Uint> = C::ORDER

Scalar modulus.

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 ScalarValue from a serialized field element

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

Decode ScalarValue from a big endian byte slice.

Errors

• if slice is not sized appropriately for Self::MODULUS.
• if the decoded scalar field element overflows Self::MODULUS.

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 ScalarValue value equal to zero?

pub fn is_even(&self) -> Choice

Is this ScalarValue value even?

pub fn is_odd(&self) -> Choice

Is this ScalarValue value odd?

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

Encode ScalarValue as a serialized field element.

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

Convert to a C::Uint.

pub fn random<R: CryptoRng + ?Sized>(rng: &mut R) -> Self

👎Deprecated since 0.14.0:

use the Generate trait instead

Deprecated: Generate a random ScalarValue.

Trait Implementations

impl<C> Add for ScalarValue<C>

where C: Curve,

type Output = ScalarValue<C>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<C> Add<&ScalarValue<C>> for ScalarValue<C>

where C: Curve,

type Output = ScalarValue<C>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<C> AddAssign for ScalarValue<C>

where C: Curve,

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<C> AddAssign<&ScalarValue<C>> for ScalarValue<C>

where C: Curve,

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

Performs the += operation.

impl<C> AsRef<[Limb]> for ScalarValue<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 ScalarValue<C>

where C::Uint: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

where C: Curve,

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

Determine whether self > other.

impl<C> ConstantTimeLess for ScalarValue<C>

where C: Curve,

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

Determine whether self < other.

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

where C::Uint: Copy,

impl<C> CtEq for ScalarValue<C>

where C: Curve,

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

Determine if self is equal to other in constant-time.

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

Determine if self is NOT equal to other in constant-time.

impl<C> CtGt for ScalarValue<C>

where C: Curve,

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

Compute whether self > other in constant time.

impl<C> CtLt for ScalarValue<C>

where C: Curve,

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

Compute whether self < other in constant time.

impl<C> CtSelect for ScalarValue<C>

where C: Curve,

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

Select between self and other based on choice, returning a copy of the value.

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

Conditionally swap self and other if choice is Choice::TRUE.

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

where C::Uint: Default,

fn default() -> ScalarValue<C>

Returns the “default value” for a type.

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

impl<C> Display for ScalarValue<C>

where C: Curve,

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

Formats the value using the given formatter.

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

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

where C: CurveArithmetic,

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

Converts to this type from the input type.

impl<C> From<NonZeroScalar<C>> for ScalarValue<C>

where C: CurveArithmetic,

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

Converts to this type from the input type.

impl<C> From<u64> for ScalarValue<C>

where C: Curve,

fn from(n: u64) -> Self

Converts to this type from the input type.

impl<C> FromStr for ScalarValue<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 ScalarValue<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> Generate for ScalarValue<C>

where C: Curve,

fn try_generate_from_rng<R: TryCryptoRng + ?Sized>( rng: &mut R, ) -> Result<Self, R::Error>

Generate random key using the provided TryCryptoRng.

fn generate_from_rng<R>(rng: &mut R) -> Self

where R: CryptoRng + ?Sized,

Generate random key using the provided CryptoRng.

fn try_generate() -> Result<Self, Error>

Randomly generate a value of this type using the system’s ambient cryptographically secure random number generator.

fn generate() -> Self

Randomly generate a value of this type using the system’s ambient cryptographically secure random number generator.

impl<C> IsHigh for ScalarValue<C>

where C: Curve,

fn is_high(&self) -> Choice

Is this scalar greater than n / 2?

impl<C> LowerHex for ScalarValue<C>

where C: Curve,

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

Formats the value using the given formatter.

impl<C> Neg for ScalarValue<C>

where C: Curve,

type Output = ScalarValue<C>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<C> Neg for &ScalarValue<C>

where C: Curve,

type Output = ScalarValue<C>

The resulting type after applying the - operator.

fn neg(self) -> ScalarValue<C>

Performs the unary - operation.

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

where C: Curve,

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

Equality operator ==.

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

Inequality operator !=.

impl<C> PartialOrd for ScalarValue<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 ScalarValue<C>

where C: Curve,

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl<C> Sub for ScalarValue<C>

where C: Curve,

type Output = ScalarValue<C>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<C> Sub<&ScalarValue<C>> for ScalarValue<C>

where C: Curve,

type Output = ScalarValue<C>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<C> SubAssign for ScalarValue<C>

where C: Curve,

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<C> SubAssign<&ScalarValue<C>> for ScalarValue<C>

where C: Curve,

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

Performs the -= operation.

impl<C> UpperHex for ScalarValue<C>

where C: Curve,

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

Formats the value using the given formatter.