Struct dusk_pki::SecretKey

pub struct SecretKey(_);

Structure repesenting a secret key

Implementations

impl SecretKey

pub fn random<T>(rand: &mut T) -> SecretKey where
    T: RngCore + CryptoRng, 

This will create a random SecretKey from a scalar of the Field JubJubScalar.

Trait Implementations

impl AsRef<Fr> for SecretKey

fn as_ref(&self) -> &JubJubScalar

Performs the conversion.

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SecretKey

impl Debug for SecretKey

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

Formats the value using the given formatter.

impl Eq for SecretKey

impl From<&'_ Fr> for SecretKey

fn from(s: &JubJubScalar) -> SecretKey

Performs the conversion.

impl From<&'_ SecretKey> for PublicKey

fn from(sk: &SecretKey) -> Self

Performs the conversion.

impl From<Fr> for SecretKey

fn from(s: JubJubScalar) -> SecretKey

Performs the conversion.

impl LowerHex for SecretKey

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

Formats the value using the given formatter.

impl Ord for SecretKey

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<SecretKey> for SecretKey

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

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

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

This method tests for !=.

impl PartialOrd<SecretKey> for SecretKey

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl Serializable<32_usize> for SecretKey

type Error = Error

The type returned in the event of a conversion error.

fn to_bytes(&self) -> [u8; 32]

Serialize Self into a [[u8; N]].

fn from_bytes(bytes: &[u8; 32]) -> Result<Self, Error>

Deserialize a [&[u8; N]] into Self, it might be fail.

pub const SIZE: usize

The size of

impl StructuralEq for SecretKey

impl StructuralPartialEq for SecretKey

impl UpperHex for SecretKey

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

Formats the value using the given formatter.