Struct elliptic_curve::scalar::NonZeroScalar

pub struct NonZeroScalar<C: Curve + Arithmetic> { /* fields omitted */ }

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: Curve + Arithmetic, 

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

Create a NonZeroScalar from a scalar, performing a constant-time check that it's non-zero.

Trait Implementations

impl<C> AsRef<<C as Arithmetic>::Scalar> for NonZeroScalar<C> where
    C: Curve + Arithmetic, 

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

Performs the conversion.

impl<C: Clone + Curve + Arithmetic> Clone for NonZeroScalar<C> where
    C::Scalar: 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> Generate for NonZeroScalar<C> where
    C: Curve + Arithmetic,
    C::Scalar: Generate, 

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

This is supported on feature="rand" only.

Generate a random element of this type using the provided CryptoRng

impl<C> Zeroize for NonZeroScalar<C> where
    C: Curve + Arithmetic,
    C::Scalar: Zeroize, 

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.