Struct elliptic_curve::NonZeroScalar

pub struct NonZeroScalar<C> where
    C: Curve + ProjectiveArithmetic,  { /* fields omitted */ }

This is supported on crate feature arithmetic only.

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 + ProjectiveArithmetic, 

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

Generate a random NonZeroScalar

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

Decode a NonZeroScalar from a serialized field element

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

Create a NonZeroScalar from a scalar.

Trait Implementations

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

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

Performs the conversion.

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

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

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

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

Determine if two items are equal.

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

type Target = Scalar<C>

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

This is supported on crate feature zeroize only.

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

This is supported on crate feature zeroize only.

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

Performs the conversion.

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

fn invert(&self) -> CtOption<Self::Output>

Perform a scalar inversion

type Output = Scalar<C>

Field element type

impl<C> TryFrom<&'_ [u8]> for NonZeroScalar<C> where
    C: Curve + ProjectiveArithmetic, 

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<C> TryFrom<ScalarBytes<C>> for NonZeroScalar<C> where
    C: Curve + ProjectiveArithmetic, 

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: ScalarBytes<C>) -> Result<NonZeroScalar<C>>

Performs the conversion.

impl<C> Zeroize for NonZeroScalar<C> where
    C: Curve + ProjectiveArithmetic,
    Scalar<C>: 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.

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