Struct k256::Scalar

Normalize scalar to the lower half of the field (i.e. negate it if it’s larger than half the curve’s order). Returns a tuple with the new scalar and a boolean indicating whether the given scalar was in the higher half. Read more

source

impl PartialEq<Scalar> for Scalar

source

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

source

impl PrimeField for Scalar

source

fn from_repr(bytes: FieldBytes) -> Option<Self>

Attempts to parse the given byte array as an SEC1-encoded scalar.

Returns None if the byte array does not contain a big-endian integer in the range [0, p).

type Repr = FieldBytes

The prime field can be converted back and forth into this binary representation. Read more

type ReprBits = [u32 ; 8]

The backing store for a bit representation of a prime field element.

source

const NUM_BITS: u32

How many bits are needed to represent an element of this field.

source

const CAPACITY: u32

How many bits of information can be reliably stored in the field element. Read more

source

const S: u32

An integer s satisfying the equation 2^s * t = modulus - 1 with t odd. Read more

source

fn to_repr(&self) -> FieldBytes

Converts an element of the prime field into the standard byte representation for this field. Read more

source

fn to_le_bits(&self) -> ScalarBits

Converts an element of the prime field into a little-endian sequence of bits.

source

fn is_odd(&self) -> bool

Returns true iff this element is odd.

source

fn char_le_bits() -> ScalarBits

Returns the bits of the field characteristic (the modulus) in little-endian order.

source

fn multiplicative_generator() -> Self

Returns a fixed multiplicative generator of modulus - 1 order. This element must also be a quadratic nonresidue. Read more

source

fn root_of_unity() -> Self

Returns the 2^s root of unity. Read more

source

fn from_str(s: &str) -> Option<Self>

Interpret a string of numbers as a (congruent) prime field element. Does not accept unnecessary leading zeroes or a blank string. Read more

source

fn is_even(&self) -> bool

Returns true iff this element is even.

source

impl RecoverableSignPrimitive<Secp256k1> for Scalar

source

fn try_sign_recoverable_prehashed<K>(
 &self,
 ephemeral_scalar: &K,
 z: &Scalar
) -> Result<(Signature, bool ), Error> where
 K: Borrow<Scalar> + Invert<Output = Scalar>,

Try to sign the prehashed message. Read more

source

impl Shr<usize> for Scalar

type Output = Self

The resulting type after applying the >> operator.

source

fn shr(self, rhs: usize) -> Self::Output

Performs the >> operation. Read more

source

impl Shr<usize> for &Scalar

type Output = Scalar

The resulting type after applying the >> operator.

source

fn shr(self, rhs: usize) -> Self::Output

Performs the >> operation. Read more

source

impl Sub<&'_ Scalar> for &Scalar

type Output = Scalar

The resulting type after applying the - operator.

source

fn sub(self, other: &Scalar) -> Scalar

Performs the - operation. Read more

source

impl Sub<&'_ Scalar> for Scalar

type Output = Scalar

The resulting type after applying the - operator.

source

fn sub(self, other: &Scalar) -> Scalar

Performs the - operation. Read more

source

impl Sub<Scalar> for Scalar

type Output = Scalar

The resulting type after applying the - operator.

source

fn sub(self, other: Scalar) -> Scalar

Performs the - operation. Read more

source

impl SubAssign<&'_ Scalar> for Scalar

source

fn sub_assign(&mut self, rhs: &Scalar)

Performs the -= operation. Read more

source

impl SubAssign<Scalar> for Scalar

source

fn sub_assign(&mut self, rhs: Scalar)

Performs the -= operation. Read more

source

impl Zeroize for Scalar

source

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

source

impl Copy for Scalar

source

impl Eq for Scalar

Auto Trait Implementations

impl RefUnwindSafe for Scalar

impl Send for Scalar

impl Sync for Scalar

impl Unpin for Scalar

impl UnwindSafe for Scalar

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

source

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

Mutably borrows from an owned value. Read more

source

impl<T> ConditionallyNegatable for T where
 T: ConditionallySelectable,
 &'a T: for<'a> Neg,
 <&'a T as Neg>::Output == T,

source

pub fn conditional_negate(&mut self, choice: Choice)

Negate self if choice == Choice(1); otherwise, leave it unchanged. Read more

source

impl<T> Conv for T

source

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

Converts self into a target type. Read more

source

impl<T> FmtForward for T

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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

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

source

impl<T> From<T> for T

source

pub fn from(t: T) -> T

Performs the conversion.

source

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

source

pub fn into(self) -> U

Performs the conversion.

source

impl<F> Invert for F where
F: Field,

type Output = F

Field element type

source

pub fn invert(&self) -> CtOption<F>

Invert a field element.

source

impl<T> Pipe for T

source

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

Pipes a value into a function that cannot ordinarily be called in suffix position. Read more

source

impl<T> PipeAsRef for T

source

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

Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more

source

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

Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more

source

impl<T> PipeBorrow for T

source

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

Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more

source

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

Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more

source

impl<T> PipeDeref for T

source

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

Pipes a dereference into a function that cannot normally be called in suffix position. Read more

source

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

Pipes a mutable dereference into a function that cannot normally be called in suffix position. Read more

source

impl<T> PipeRef for T

source

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

Pipes a reference into a function that cannot ordinarily be called in suffix position. Read more

source

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

Pipes a mutable reference into a function that cannot ordinarily be called in suffix position. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> Tap for T

source

fn tap<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R,

Provides immutable access for inspection. Read more

source

fn tap_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R,

Calls tap in debug builds, and does nothing in release builds.

source

fn tap_mut<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,

Provides mutable access for modification. Read more

source

fn tap_mut_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R,

Calls tap_mut in debug builds, and does nothing in release builds.

source

impl<T, U> TapAsRef for T where
U: ?Sized,

source

fn tap_ref<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,

Provides immutable access to the reference for inspection.

source

fn tap_ref_dbg<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R,

Calls tap_ref in debug builds, and does nothing in release builds.

source

fn tap_ref_mut<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,

Provides mutable access to the reference for modification.

source

fn tap_ref_mut_dbg<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,

Calls tap_ref_mut in debug builds, and does nothing in release builds.

source

impl<T, U> TapBorrow for T where
U: ?Sized,

source

fn tap_borrow<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,

Provides immutable access to the borrow for inspection. Read more

source

fn tap_borrow_dbg<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R,

Calls tap_borrow in debug builds, and does nothing in release builds.

source

fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,

Provides mutable access to the borrow for modification.

source

fn tap_borrow_mut_dbg<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,

Calls tap_borrow_mut in debug builds, and does nothing in release builds. Read more

source

impl<T> TapDeref for T

source

fn tap_deref<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,

Immutably dereferences self for inspection.

source

fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,

Calls tap_deref in debug builds, and does nothing in release builds.

source

fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,

Mutably dereferences self for modification.

source

fn tap_deref_mut_dbg<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,

Calls tap_deref_mut in debug builds, and does nothing in release builds. Read more

source

impl<T> TryConv for T

source

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

Attempts to convert self into a target type. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T, Rhs, Output> GroupOps<Rhs, Output> for T where
T: Add<Rhs, Output = Output> + Sub<Rhs, Output = Output> + AddAssign<Rhs> + SubAssign<Rhs>,

source

impl<T, Rhs, Output> GroupOpsOwned<Rhs, Output> for T where
T: for<'r> GroupOps<&'r Rhs, Output>,

source

impl<T, Rhs, Output> ScalarMul<Rhs, Output> for T where
T: Mul<Rhs, Output = Output> + MulAssign<Rhs>,

source

Struct k256::Scalar

Implementations

impl Scalar

pub const fn zero() -> Self

pub const fn one() -> Scalar

pub fn is_zero(&self) -> Choice

pub fn truncate_to_u32(&self) -> u32

pub fn from_bytes_reduced(bytes: &FieldBytes) -> Self

pub fn to_bytes(&self) -> FieldBytes

pub fn is_high(&self) -> Choice

pub fn negate(&self) -> Self

pub fn add(&self, rhs: &Scalar) -> Scalar

pub fn sub(&self, rhs: &Scalar) -> Scalar

pub fn mul(&self, rhs: &Scalar) -> Scalar

pub fn square(&self) -> Self

pub fn rshift(&self, shift: usize) -> Scalar

pub fn invert(&self) -> CtOption<Self>

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

pub fn generate_vartime(rng: impl RngCore) -> Self

pub fn conditional_add_bit(&self, bit: usize, flag: Choice) -> Self

pub fn mul_shift_var(&self, b: &Scalar, shift: usize) -> Self

Trait Implementations

impl Add<&'_ Scalar> for &Scalar

type Output = Scalar

fn add(self, other: &Scalar) -> Scalar

impl Add<&'_ Scalar> for Scalar

type Output = Scalar

fn add(self, other: &Scalar) -> Scalar

impl Add<Scalar> for Scalar

type Output = Scalar

fn add(self, other: Scalar) -> Scalar

impl Add<Scalar> for &Scalar

type Output = Scalar

fn add(self, other: Scalar) -> Scalar

impl AddAssign<&'_ Scalar> for Scalar

fn add_assign(&mut self, rhs: &Scalar)

impl AddAssign<Scalar> for Scalar

fn add_assign(&mut self, rhs: Scalar)

impl Clone for Scalar

fn clone(&self) -> Scalar

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

impl ConditionallySelectable for Scalar

fn conditional_select(a: &Self, b: &Self, choice: Choice) -> Self

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

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

impl ConstantTimeEq for Scalar

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

impl Debug for Scalar

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

impl Default for Scalar

fn default() -> Scalar

impl Field for Scalar

fn random(rng: impl RngCore) -> Self

fn zero() -> Self

fn one() -> Self

fn is_zero(&self) -> bool

fn square(&self) -> Self

fn double(&self) -> Self

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

fn sqrt(&self) -> CtOption<Self>

fn cube(&self) -> Self

fn pow_vartime<S>(&self, exp: S) -> Self where S: AsRef<[u64]>,

impl From<&'_ Scalar> for ScalarBits

fn from(scalar: &Scalar) -> ScalarBits

impl From<&'_ Scalar> for FieldBytes

fn from(scalar: &Scalar) -> Self

impl From<Scalar> for FieldBytes

fn from(scalar: Scalar) -> Self

impl From<u32> for Scalar

fn from(k: u32) -> Self

impl From<u64> for Scalar

fn from(k: u64) -> Self

impl FromDigest<Secp256k1> for Scalar

fn from_digest<D>(digest: D) -> Self where D: Digest<OutputSize = U32>,

impl Mul<&'_ Scalar> for &ProjectivePoint

type Output = ProjectivePoint

fn mul(self, other: &Scalar) -> ProjectivePoint

impl Mul<&'_ Scalar> for ProjectivePoint

type Output = ProjectivePoint

fn mul(self, other: &Scalar) -> ProjectivePoint

fn pow_vartime<S>(&self, exp: S) -> Self where
S: AsRef<[u64 ]>,

fn from_digest<D>(digest: D) -> Self where
D: Digest<OutputSize = U32>,

fn normalize_low(&self) -> (Self, bool )

type ReprBits = [u32 ; 8]

fn try_sign_recoverable_prehashed<K>(
&self,
ephemeral_scalar: &K,
z: &Scalar
) -> Result<(Signature, bool ), Error> where
K: Borrow<Scalar> + Invert<Output = Scalar>,