Struct NonZeroScalar

pub struct NonZeroScalar<C>
where
    C: CurveArithmetic,
{ /* private fields */ }

Non-zero scalar type.

This type ensures that its value is not zero, ala core::num::NonZero*. To do this, the generic S type must impl both Default and ConstantTimeEq, with the requirement that S::default() returns 0.

In the context of ECC, it’s useful for ensuring that scalar multiplication cannot result in the point at infinity.

Implementations

impl<C> NonZeroScalar<C>

where C: CurveArithmetic,

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

Generate a random NonZeroScalar.

pub fn new(scalar: Scalar<C>) -> CtOption<Self>

Create a NonZeroScalar from a scalar.

pub fn from_repr(repr: FieldBytes<C>) -> CtOption<Self>

Decode a NonZeroScalar from a big endian-serialized field element.

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

Create a NonZeroScalar from a C::Uint.

Trait Implementations

impl<C> AsRef<<C as CurveArithmetic>::Scalar> for NonZeroScalar<C>

where C: CurveArithmetic,

fn as_ref(&self) -> &Scalar<C>

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

impl<C> Clone for NonZeroScalar<C>

where C: CurveArithmetic + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> ConditionallySelectable for NonZeroScalar<C>

where C: CurveArithmetic,

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

where C: CurveArithmetic,

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

Determine if two items are equal.

impl<C> Deref for NonZeroScalar<C>

where C: CurveArithmetic,

type Target = <C as CurveArithmetic>::Scalar

The resulting type after dereferencing.

fn deref(&self) -> &Scalar<C>

Dereferences the value.

impl<C> Display for NonZeroScalar<C>

where C: CurveArithmetic,

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

Formats the value using the given formatter.

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

where C: CurveArithmetic,

fn from(scalar: &NonZeroScalar<C>) -> FieldBytes<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<&NonZeroScalar<C>> for SecretKey<C>

where C: CurveArithmetic,

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

Converts to this type from the input type.

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

where C: CurveArithmetic,

fn from(sk: &SecretKey<C>) -> NonZeroScalar<C>

Converts to this type from the input type.

impl<C> From<NonZeroScalar<C>> for FieldBytes<C>

where C: CurveArithmetic,

fn from(scalar: NonZeroScalar<C>) -> FieldBytes<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<NonZeroScalar<C>> for SecretKey<C>

where C: CurveArithmetic,

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

Converts to this type from the input type.

impl<C> From<SecretKey<C>> for NonZeroScalar<C>

where C: CurveArithmetic,

fn from(sk: SecretKey<C>) -> NonZeroScalar<C>

Converts to this type from the input type.

impl<C> FromStr for NonZeroScalar<C>

where C: CurveArithmetic,

type Err = Error

The associated error which can be returned from parsing.

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

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

impl<C> Invert for NonZeroScalar<C>

where C: CurveArithmetic, Scalar<C>: Invert<Output = CtOption<Scalar<C>>>,

type Output = NonZeroScalar<C>

Field element type

fn invert(&self) -> Self

Invert a field element.

fn invert_vartime(&self) -> Self::Output

Invert a field element in variable time.

impl<C> IsHigh for NonZeroScalar<C>

where C: CurveArithmetic,

fn is_high(&self) -> Choice

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

impl<C> LowerHex for NonZeroScalar<C>

where C: CurveArithmetic,

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

Formats the value using the given formatter.

impl<C, P> Mul<&NonZeroScalar<C>> for &NonIdentity<P>

where C: CurveArithmetic, P: Copy + Mul<Scalar<C>, Output = P>,

type Output = NonIdentity<P>

The resulting type after applying the * operator.

fn mul(self, rhs: &NonZeroScalar<C>) -> Self::Output

Performs the * operation.

impl<C> Mul<&NonZeroScalar<C>> for NonZeroScalar<C>

where C: PrimeCurve + CurveArithmetic,

type Output = NonZeroScalar<C>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<C, P> Mul<NonZeroScalar<C>> for NonIdentity<P>

where C: CurveArithmetic, P: Copy + Mul<Scalar<C>, Output = P>,

type Output = NonIdentity<P>

The resulting type after applying the * operator.

fn mul(self, rhs: NonZeroScalar<C>) -> Self::Output

Performs the * operation.

impl<C> Mul for NonZeroScalar<C>

where C: PrimeCurve + CurveArithmetic,

type Output = NonZeroScalar<C>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<C> Neg for NonZeroScalar<C>

where C: CurveArithmetic,

type Output = NonZeroScalar<C>

The resulting type after applying the - operator.

fn neg(self) -> NonZeroScalar<C>

Performs the unary - operation.

impl<C, I> Reduce<I> for NonZeroScalar<C>

where C: CurveArithmetic, I: Integer + ArrayEncoding, Scalar<C>: Reduce<I> + ReduceNonZero<I>,

Note: this is a non-zero reduction, as it’s impl’d for NonZeroScalar.

type Bytes = <<C as CurveArithmetic>::Scalar as Reduce<I>>::Bytes

Bytes used as input to Reduce::reduce_bytes.

fn reduce(n: I) -> Self

Perform a modular reduction, returning a field element.

fn reduce_bytes(bytes: &Self::Bytes) -> Self

Interpret the given bytes as an integer and perform a modular reduction.

impl<C, I> ReduceNonZero<I> for NonZeroScalar<C>

where Self: Reduce<I>, C: CurveArithmetic, I: Integer + ArrayEncoding, Scalar<C>: Reduce<I, Bytes = Self::Bytes> + ReduceNonZero<I>,

Note: forwards to the Reduce impl.

fn reduce_nonzero(n: I) -> Self

Perform a modular reduction, returning a field element.

fn reduce_nonzero_bytes(bytes: &Self::Bytes) -> Self

Interpret the given bytes as an integer and perform a modular reduction to a non-zero output.

impl<C> TryFrom<&[u8]> for NonZeroScalar<C>

where C: CurveArithmetic,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self, Error>

Performs the conversion.

impl<C> UpperHex for NonZeroScalar<C>

where C: CurveArithmetic,

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

Formats the value using the given formatter.

impl<C> Zeroize for NonZeroScalar<C>

where C: CurveArithmetic,

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<C> Copy for NonZeroScalar<C>

where C: CurveArithmetic,