Struct elliptic_curve::scalar::NonZeroScalar
source · pub struct NonZeroScalar<C>where
C: CurveArithmetic,{ /* private fields */ }
Available on crate feature
arithmetic
only.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§
source§impl<C> NonZeroScalar<C>where
C: CurveArithmetic,
impl<C> NonZeroScalar<C>where C: CurveArithmetic,
sourcepub fn random(rng: &mut impl CryptoRngCore) -> Self
pub fn random(rng: &mut impl CryptoRngCore) -> Self
Generate a random NonZeroScalar
.
sourcepub fn new(scalar: Scalar<C>) -> CtOption<Self>
pub fn new(scalar: Scalar<C>) -> CtOption<Self>
Create a NonZeroScalar
from a scalar.
sourcepub fn from_repr(repr: FieldBytes<C>) -> CtOption<Self>
pub fn from_repr(repr: FieldBytes<C>) -> CtOption<Self>
Decode a NonZeroScalar
from a big endian-serialized field element.
sourcepub fn from_uint(uint: C::Uint) -> CtOption<Self>
pub fn from_uint(uint: C::Uint) -> CtOption<Self>
Create a NonZeroScalar
from a C::Uint
.
Trait Implementations§
source§impl<C> AsRef<<C as CurveArithmetic>::Scalar> for NonZeroScalar<C>where
C: CurveArithmetic,
impl<C> AsRef<<C as CurveArithmetic>::Scalar> for NonZeroScalar<C>where C: CurveArithmetic,
source§impl<C> Clone for NonZeroScalar<C>where
C: CurveArithmetic + Clone,
impl<C> Clone for NonZeroScalar<C>where C: CurveArithmetic + Clone,
source§fn clone(&self) -> NonZeroScalar<C>
fn clone(&self) -> NonZeroScalar<C>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<C> ConditionallySelectable for NonZeroScalar<C>where
C: CurveArithmetic,
impl<C> ConditionallySelectable for NonZeroScalar<C>where C: CurveArithmetic,
source§impl<C> ConstantTimeEq for NonZeroScalar<C>where
C: CurveArithmetic,
impl<C> ConstantTimeEq for NonZeroScalar<C>where C: CurveArithmetic,
source§impl<C> Deref for NonZeroScalar<C>where
C: CurveArithmetic,
impl<C> Deref for NonZeroScalar<C>where C: CurveArithmetic,
source§impl<'de, C> Deserialize<'de> for NonZeroScalar<C>where
C: CurveArithmetic,
Available on crate feature serde
only.
impl<'de, C> Deserialize<'de> for NonZeroScalar<C>where C: CurveArithmetic,
Available on crate feature
serde
only.source§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl<C> Display for NonZeroScalar<C>where
C: CurveArithmetic,
impl<C> Display for NonZeroScalar<C>where C: CurveArithmetic,
source§impl<C> From<&NonZeroScalar<C>> for FieldBytes<C>where
C: CurveArithmetic,
impl<C> From<&NonZeroScalar<C>> for FieldBytes<C>where C: CurveArithmetic,
source§fn from(scalar: &NonZeroScalar<C>) -> FieldBytes<C>
fn from(scalar: &NonZeroScalar<C>) -> FieldBytes<C>
Converts to this type from the input type.
source§impl<C> From<&NonZeroScalar<C>> for ScalarPrimitive<C>where
C: CurveArithmetic,
impl<C> From<&NonZeroScalar<C>> for ScalarPrimitive<C>where C: CurveArithmetic,
source§fn from(scalar: &NonZeroScalar<C>) -> ScalarPrimitive<C>
fn from(scalar: &NonZeroScalar<C>) -> ScalarPrimitive<C>
Converts to this type from the input type.
source§impl<C> From<&NonZeroScalar<C>> for SecretKey<C>where
C: CurveArithmetic,
impl<C> From<&NonZeroScalar<C>> for SecretKey<C>where C: CurveArithmetic,
source§fn from(scalar: &NonZeroScalar<C>) -> SecretKey<C>
fn from(scalar: &NonZeroScalar<C>) -> SecretKey<C>
Converts to this type from the input type.
source§impl<C> From<&SecretKey<C>> for NonZeroScalar<C>where
C: CurveArithmetic,
impl<C> From<&SecretKey<C>> for NonZeroScalar<C>where C: CurveArithmetic,
source§fn from(sk: &SecretKey<C>) -> NonZeroScalar<C>
fn from(sk: &SecretKey<C>) -> NonZeroScalar<C>
Converts to this type from the input type.
source§impl<C> From<NonZeroScalar<C>> for FieldBytes<C>where
C: CurveArithmetic,
impl<C> From<NonZeroScalar<C>> for FieldBytes<C>where C: CurveArithmetic,
source§fn from(scalar: NonZeroScalar<C>) -> FieldBytes<C>
fn from(scalar: NonZeroScalar<C>) -> FieldBytes<C>
Converts to this type from the input type.
source§impl<C> From<NonZeroScalar<C>> for ScalarPrimitive<C>where
C: CurveArithmetic,
impl<C> From<NonZeroScalar<C>> for ScalarPrimitive<C>where C: CurveArithmetic,
source§fn from(scalar: NonZeroScalar<C>) -> ScalarPrimitive<C>
fn from(scalar: NonZeroScalar<C>) -> ScalarPrimitive<C>
Converts to this type from the input type.
source§impl<C> From<NonZeroScalar<C>> for SecretKey<C>where
C: CurveArithmetic,
impl<C> From<NonZeroScalar<C>> for SecretKey<C>where C: CurveArithmetic,
source§fn from(scalar: NonZeroScalar<C>) -> SecretKey<C>
fn from(scalar: NonZeroScalar<C>) -> SecretKey<C>
Converts to this type from the input type.
source§impl<C> From<SecretKey<C>> for NonZeroScalar<C>where
C: CurveArithmetic,
impl<C> From<SecretKey<C>> for NonZeroScalar<C>where C: CurveArithmetic,
source§fn from(sk: SecretKey<C>) -> NonZeroScalar<C>
fn from(sk: SecretKey<C>) -> NonZeroScalar<C>
Converts to this type from the input type.
source§impl<C> FromStr for NonZeroScalar<C>where
C: CurveArithmetic,
impl<C> FromStr for NonZeroScalar<C>where C: CurveArithmetic,
source§impl<C> Invert for NonZeroScalar<C>where
C: CurveArithmetic,
Scalar<C>: Invert<Output = CtOption<Scalar<C>>>,
impl<C> Invert for NonZeroScalar<C>where C: CurveArithmetic, Scalar<C>: Invert<Output = CtOption<Scalar<C>>>,
source§impl<C> IsHigh for NonZeroScalar<C>where
C: CurveArithmetic,
impl<C> IsHigh for NonZeroScalar<C>where C: CurveArithmetic,
source§impl<C> LowerHex for NonZeroScalar<C>where
C: CurveArithmetic,
impl<C> LowerHex for NonZeroScalar<C>where C: CurveArithmetic,
source§impl<C, P> Mul<&NonZeroScalar<C>> for &NonIdentity<P>where
C: CurveArithmetic,
P: Copy + Mul<Scalar<C>, Output = P>,
impl<C, P> Mul<&NonZeroScalar<C>> for &NonIdentity<P>where C: CurveArithmetic, P: Copy + Mul<Scalar<C>, Output = P>,
§type Output = NonIdentity<P>
type Output = NonIdentity<P>
The resulting type after applying the
*
operator.source§impl<C> Mul<&NonZeroScalar<C>> for NonZeroScalar<C>where
C: PrimeCurve + CurveArithmetic,
impl<C> Mul<&NonZeroScalar<C>> for NonZeroScalar<C>where C: PrimeCurve + CurveArithmetic,
source§impl<C, P> Mul<NonZeroScalar<C>> for NonIdentity<P>where
C: CurveArithmetic,
P: Copy + Mul<Scalar<C>, Output = P>,
impl<C, P> Mul<NonZeroScalar<C>> for NonIdentity<P>where C: CurveArithmetic, P: Copy + Mul<Scalar<C>, Output = P>,
§type Output = NonIdentity<P>
type Output = NonIdentity<P>
The resulting type after applying the
*
operator.source§impl<C> Mul for NonZeroScalar<C>where
C: PrimeCurve + CurveArithmetic,
impl<C> Mul for NonZeroScalar<C>where C: PrimeCurve + CurveArithmetic,
source§impl<C> Neg for NonZeroScalar<C>where
C: CurveArithmetic,
impl<C> Neg for NonZeroScalar<C>where C: CurveArithmetic,
§type Output = NonZeroScalar<C>
type Output = NonZeroScalar<C>
The resulting type after applying the
-
operator.source§fn neg(self) -> NonZeroScalar<C>
fn neg(self) -> NonZeroScalar<C>
Performs the unary
-
operation. Read moresource§impl<C, I> Reduce<I> for NonZeroScalar<C>where
C: CurveArithmetic,
I: Integer + ArrayEncoding,
Scalar<C>: Reduce<I> + ReduceNonZero<I>,
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
type Bytes = <<C as CurveArithmetic>::Scalar as Reduce<I>>::Bytes
Bytes used as input to
Reduce::reduce_bytes
.source§fn reduce_bytes(bytes: &Self::Bytes) -> Self
fn reduce_bytes(bytes: &Self::Bytes) -> Self
Interpret the given bytes as an integer and perform a modular reduction.
source§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>,
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.
source§fn reduce_nonzero(n: I) -> Self
fn reduce_nonzero(n: I) -> Self
Perform a modular reduction, returning a field element.
source§fn reduce_nonzero_bytes(bytes: &Self::Bytes) -> Self
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.
source§impl<C> Serialize for NonZeroScalar<C>where
C: CurveArithmetic,
Available on crate feature serde
only.
impl<C> Serialize for NonZeroScalar<C>where C: CurveArithmetic,
Available on crate feature
serde
only.source§impl<C> TryFrom<&[u8]> for NonZeroScalar<C>where
C: CurveArithmetic,
impl<C> TryFrom<&[u8]> for NonZeroScalar<C>where C: CurveArithmetic,
source§impl<C> UpperHex for NonZeroScalar<C>where
C: CurveArithmetic,
impl<C> UpperHex for NonZeroScalar<C>where C: CurveArithmetic,
source§impl<C> Zeroize for NonZeroScalar<C>where
C: CurveArithmetic,
impl<C> Zeroize for NonZeroScalar<C>where C: CurveArithmetic,
impl<C> Copy for NonZeroScalar<C>where C: CurveArithmetic,
Auto Trait Implementations§
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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
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,
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,
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,
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,
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,
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,
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,
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,
fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,
Borrows
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,
Mutably borrows
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,
Borrows
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,
Mutably borrows
self
, then passes self.as_mut()
into the pipe
function.source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
Immutable access to the
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
Mutable access to the
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
Immutable access to the
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
Mutable access to the
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,
Immutable access to the
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,
Mutable access to the
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
Calls
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.