Struct NonIdentity 

#[repr(transparent)]
pub struct NonIdentity<P> {
    point: P,
}

Non-identity point type.

This type ensures that its value is not the identity point, ala core::num::NonZero*.

In the context of ECC, it’s useful for ensuring that certain arithmetic cannot result in the identity point.

Fields

point: P

Implementations

impl<P> NonIdentity<P>

where P: ConditionallySelectable + ConstantTimeEq + Default,

pub fn new(point: P) -> CtOption<Self>

Create a NonIdentity from a point.

pub(crate) fn new_unchecked(point: P) -> Self

impl<P> NonIdentity<P>

where P: ConditionallySelectable + ConstantTimeEq + Default + GroupEncoding,

pub fn from_repr(repr: &P::Repr) -> CtOption<Self>

Decode a NonIdentity from its encoding.

impl<P> NonIdentity<P>

pub fn array_as_inner<const N: usize>(points: &[Self; N]) -> &[P; N]

Transform array reference containing NonIdentity points to an array reference to the inner point type.

pub fn slice_as_inner(points: &[Self]) -> &[P]

Transform slice containing NonIdentity points to a slice of the inner point type.

pub fn cast_array_as_inner<const N: usize>(points: &[Self; N]) -> &[P; N]

👎Deprecated since 0.14.0: use NonIdentity::array_as_inner instead

Transform array reference containing NonIdentity points to an array reference to the inner point type.

pub fn cast_slice_as_inner(points: &[Self]) -> &[P]

👎Deprecated since 0.14.0: use NonIdentity::slice_as_inner instead

Transform slice containing NonIdentity points to a slice of the inner point type.

impl<P: Copy> NonIdentity<P>

pub fn to_point(self) -> P

Return wrapped point.

impl<P> NonIdentity<P>

where P: ConditionallySelectable + ConstantTimeEq + CurveGroup + Default,

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

👎Deprecated since 0.14.0: use the Generate trait instead

Generate a random NonIdentity<ProjectivePoint>.

pub fn to_affine(self) -> NonIdentity<P::Affine>

Converts this element into its affine representation.

pub fn mul_by_generator<C: CurveArithmetic>(scalar: &NonZeroScalar<C>) -> Self

where P: Group<Scalar = C::Scalar>,

Multiply by the generator of the prime-order subgroup.

impl<P> NonIdentity<P>

where P: PrimeCurveAffine,

pub fn to_curve(self) -> NonIdentity<P::Curve>

Converts this element to its curve representation.

Trait Implementations

impl<P> AsRef<P> for NonIdentity<P>

fn as_ref(&self) -> &P

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

impl<P> BatchNormalize<[NonIdentity<P>]> for NonIdentity<P>

where P: CurveGroup + BatchNormalize<[P], Output = Vec<P::Affine>>,

Available on crate feature alloc only.

type Output = Vec<NonIdentity<<P as Curve>::Affine>>

The output of the batch normalization; a container of affine points.

fn batch_normalize(points: &[Self]) -> Vec<NonIdentity<P::Affine>>

Perform a batched conversion to affine representation on a sequence of projective points at an amortized cost that should be practically as efficient as a single conversion. Internally, implementors should rely upon InvertBatch.

fn batch_normalize_vartime(points: &Points) -> Self::Output

Perform a batched conversion to affine representation on a sequence of projective points in variable-time.

impl<const N: usize, P> BatchNormalize<[NonIdentity<P>; N]> for NonIdentity<P>

where P: CurveGroup + BatchNormalize<[P; N], Output = [P::Affine; N]>,

type Output = [NonIdentity<<P as Curve>::Affine>; N]

The output of the batch normalization; a container of affine points.

fn batch_normalize(points: &[Self; N]) -> [NonIdentity<P::Affine>; N]

Perform a batched conversion to affine representation on a sequence of projective points at an amortized cost that should be practically as efficient as a single conversion. Internally, implementors should rely upon InvertBatch.

fn batch_normalize_vartime(points: &Points) -> Self::Output

Perform a batched conversion to affine representation on a sequence of projective points in variable-time.

impl<P: Clone> Clone for NonIdentity<P>

fn clone(&self) -> NonIdentity<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P> ConditionallySelectable for NonIdentity<P>

where P: ConditionallySelectable,

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<P> ConstantTimeEq for NonIdentity<P>

where P: ConstantTimeEq,

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<P: Debug> Debug for NonIdentity<P>

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

Formats the value using the given formatter.

impl<P> Deref for NonIdentity<P>

type Target = P

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<C, P> From<&NonIdentity<P>> for PublicKey<C>

where C: CurveArithmetic, P: Copy + Into<AffinePoint<C>>,

fn from(value: &NonIdentity<P>) -> Self

Converts to this type from the input type.

impl<C> From<&PublicKey<C>> for NonIdentity<AffinePoint<C>>

where C: CurveArithmetic,

fn from(value: &PublicKey<C>) -> Self

Converts to this type from the input type.

impl<C, P> From<NonIdentity<P>> for PublicKey<C>

where C: CurveArithmetic, P: Copy + Into<AffinePoint<C>>,

fn from(value: NonIdentity<P>) -> Self

Converts to this type from the input type.

impl<C> From<PublicKey<C>> for NonIdentity<AffinePoint<C>>

where C: CurveArithmetic,

fn from(value: PublicKey<C>) -> Self

Converts to this type from the input type.

impl<P> Generate for NonIdentity<P>

where P: ConditionallySelectable + ConstantTimeEq + Default + Generate,

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<P> GroupEncoding for NonIdentity<P>

where P: ConditionallySelectable + ConstantTimeEq + Default + GroupEncoding,

type Repr = <P as GroupEncoding>::Repr

The encoding of group elements.

fn from_bytes(bytes: &Self::Repr) -> CtOption<Self>

Attempts to deserialize a group element from its encoding.

fn from_bytes_unchecked(bytes: &Self::Repr) -> CtOption<Self>

Attempts to deserialize a group element, not checking if the element is valid.

fn to_bytes(&self) -> Self::Repr

Converts this element into its byte encoding. This may or may not support encoding the identity.

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

where C: CurveArithmetic, for<'a> &'a NonIdentity<P>: Mul<&'a NonZeroScalar<C>, Output = NonIdentity<P>>,

type Output = NonIdentity<P>

The resulting type after applying the * operator.

fn mul(self, rhs: &NonIdentity<P>) -> Self::Output

Performs the * operation.

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

where C: CurveArithmetic, for<'a> &'a NonIdentity<P>: Mul<NonZeroScalar<C>, Output = NonIdentity<P>>,

type Output = NonIdentity<P>

The resulting type after applying the * operator.

fn mul(self, rhs: &NonIdentity<P>) -> Self::Output

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, 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, P> Mul<NonIdentity<P>> for &NonZeroScalar<C>

where C: CurveArithmetic, for<'a> NonIdentity<P>: Mul<&'a NonZeroScalar<C>, Output = NonIdentity<P>>,

type Output = NonIdentity<P>

The resulting type after applying the * operator.

fn mul(self, rhs: NonIdentity<P>) -> Self::Output

Performs the * operation.

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

where C: CurveArithmetic, NonIdentity<P>: Mul<NonZeroScalar<C>, Output = NonIdentity<P>>,

type Output = NonIdentity<P>

The resulting type after applying the * operator.

fn mul(self, rhs: NonIdentity<P>) -> Self::Output

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, 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<P: PartialEq> PartialEq for NonIdentity<P>

fn eq(&self, other: &NonIdentity<P>) -> 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<P: Group> Zeroize for NonIdentity<P>

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<P: Copy> Copy for NonIdentity<P>

impl<P: Eq> Eq for NonIdentity<P>

impl<P> StructuralPartialEq for NonIdentity<P>