Struct secp256k1::key::SecretKey

[+] Show declaration

pub struct SecretKey(_);

[−] Expand description

Secret 256-bit key used as x in an ECDSA signature

Implementations

impl SecretKey[−]

pub fn as_ptr(&self) -> *const u8[−]

Converts the object to a raw pointer for FFI interfacing

pub fn as_mut_ptr(&mut self) -> *mut u8[−]

Converts the object to a mutable raw pointer for FFI interfacing

pub fn as_ref(&self) -> &[u8; 32][−]

Gets a reference to the underlying array

pub fn len(&self) -> usize[−]

Returns the length of the object as an array

pub fn is_empty(&self) -> bool[−]

Returns whether the object as an array is empty

impl SecretKey[−]

pub fn new<R: Rng + ?Sized>(rng: &mut R) -> SecretKey[−]

Creates a new random secret key. Requires compilation with the “rand” feature.

pub fn from_slice(data: &[u8]) -> Result<SecretKey, Error>[−]

Converts a SECRET_KEY_SIZE-byte slice to a secret key

pub fn negate_assign(&mut self)[−]

Negates one secret key.

pub fn add_assign(&mut self, other: &[u8]) -> Result<(), Error>[−]

Adds one secret key to another, modulo the curve order. WIll return an error if the resulting key would be invalid or if the tweak was not a 32-byte length slice.

pub fn mul_assign(&mut self, other: &[u8]) -> Result<(), Error>[−]

Multiplies one secret key by another, modulo the curve order. Will return an error if the resulting key would be invalid or if the tweak was not a 32-byte length slice.

Trait Implementations

impl CPtr for SecretKey[+]

[+] Show hidden undocumented items

type Target = u8

fn as_c_ptr(&self) -> *const Self::Target

fn as_mut_c_ptr(&mut self) -> *mut Self::Target

impl Clone for SecretKey[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Display for SecretKey[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Eq for SecretKey

impl FromStr for SecretKey[+]

[+] Show hidden undocumented items

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<SecretKey, Error>[−]

Parses a string s to return a value of this type.

impl Index<Range<usize>> for SecretKey[+]

[+] Show hidden undocumented items

type Output = [u8]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &[u8][−]

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for SecretKey[+]

[+] Show hidden undocumented items

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &[u8][−]

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for SecretKey[+]

[+] Show hidden undocumented items

type Output = [u8]

The returned type after indexing.

fn index(&self, _: RangeFull) -> &[u8][−]

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for SecretKey[+]

[+] Show hidden undocumented items

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &[u8][−]

Performs the indexing (container[index]) operation.

impl Index<usize> for SecretKey[+]

[+] Show hidden undocumented items

type Output = u8

The returned type after indexing.

fn index(&self, index: usize) -> &u8[−]

Performs the indexing (container[index]) operation.

impl LowerHex for SecretKey[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Ord for SecretKey[+]

[+] Show hidden undocumented items

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

This method returns an Ordering between self and other.

[+] Expand attributes

#[must_use]pub fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use]pub fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self[−]

Restrict a value to a certain interval.

impl PartialEq<SecretKey> for SecretKey[+]

[+] Show hidden undocumented items

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

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

[+] Expand attributes

#[must_use]pub fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl PartialOrd<SecretKey> for SecretKey[+]

[+] Show hidden undocumented items

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

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

[+] Expand attributes

#[must_use]pub fn lt(&self, other: &Rhs) -> bool[−]

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

[+] Expand attributes

#[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.

[+] Expand attributes

#[must_use]pub fn gt(&self, other: &Rhs) -> bool[−]

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

[+] Expand attributes

#[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.