elliptic_curve::scalar

Struct NonZeroScalar

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

Expand description

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. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

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. Read more

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

Conditionally assign other to self, according to choice. Read more

fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)

Conditionally swap self and other if choice == 1; otherwise, reassign both unto themselves. Read more

impl<C> ConstantTimeEq for NonZeroScalar<C>
where C: CurveArithmetic,

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

Determine if two items are equal. Read more

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

Determine if two items are NOT equal. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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,

Auto Trait Implementations§

impl<C> Freeze for NonZeroScalar<C>
where <C as CurveArithmetic>::Scalar: Freeze,

impl<C> RefUnwindSafe for NonZeroScalar<C>
where <C as CurveArithmetic>::Scalar: RefUnwindSafe,

impl<C> Send for NonZeroScalar<C>

impl<C> Sync for NonZeroScalar<C>

impl<C> Unpin for NonZeroScalar<C>
where <C as CurveArithmetic>::Scalar: Unpin,

impl<C> UnwindSafe for NonZeroScalar<C>
where <C as CurveArithmetic>::Scalar: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<A, T> AsBits<T> for A
where A: AsRef<[T]>, T: BitStore,

fn as_bits<O>(&self) -> &BitSlice<T, O> ⓘ
where O: BitOrder,

Views self as an immutable bit-slice region with the O ordering.

fn try_as_bits<O>(&self) -> Result<&BitSlice<T, O>, BitSpanError<T>>
where O: BitOrder,

Attempts to view self as an immutable bit-slice region with the O ordering. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.