Struct breez_sdk_core::bitcoin::util::key::secp256k1::scalar::Scalar

pub struct Scalar(/* private fields */);

Positive 256-bit integer guaranteed to be less than the secp256k1 curve order.

The difference between PrivateKey and Scalar is that Scalar doesn’t guarantee being securely usable as a private key.

Warning: the operations on this type are NOT constant time! Using this with secret values is not advised.

Implementations

impl Scalar

pub const ZERO: Scalar = _

Scalar representing 0

pub const ONE: Scalar = _

Scalar representing 1

pub const MAX: Scalar = _

Maximum valid value: curve_order - 1

pub fn random() -> Scalar

Generates a random scalar

pub fn random_custom<R>(rng: R) -> Scalar

where R: Rng,

Generates a random scalar using supplied RNG

pub fn from_be_bytes(value: [u8; 32]) -> Result<Scalar, OutOfRangeError>

Tries to deserialize from big endian bytes

Security warning: this function is not constant time! Passing secret data is not recommended.

Errors

Returns error when the value is above the curve order.

pub fn from_le_bytes(value: [u8; 32]) -> Result<Scalar, OutOfRangeError>

Tries to deserialize from little endian bytes

Security warning: this function is not constant time! Passing secret data is not recommended.

Errors

Returns error when the value is above the curve order.

pub fn to_be_bytes(self) -> [u8; 32]

Serializes to big endian bytes

pub fn to_le_bytes(self) -> [u8; 32]

Serializes to little endian bytes

Trait Implementations

impl Clone for Scalar

fn clone(&self) -> Scalar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<SecretKey> for Scalar

fn from(value: SecretKey) -> Scalar

Converts to this type from the input type.

impl Ord for Scalar

fn cmp(&self, other: &Scalar) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Scalar

fn eq(&self, other: &Scalar) -> 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 PartialOrd for Scalar

fn partial_cmp(&self, other: &Scalar) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Scalar

impl Eq for Scalar

impl StructuralPartialEq for Scalar