Struct parity_crypto::publickey::Secret

source · [−]

pub struct Secret { /* private fields */ }

Expand description

Represents secret key

Implementations

source

impl Secret

source

pub fn copy_from_slice(key: &[u8 ]) -> Option<Self>

Creates a Secret from the given slice, returning None if the slice length != 32. Caller is responsible to zeroize input slice.

source

pub fn copy_from_str(s: &str) -> Result<Self, Error>

Creates a Secret from the given str representation, returning an error for hex big endian representation of the secret. Caller is responsible to zeroize input slice.

source

pub fn zero() -> Self

Creates zero key, which is invalid for crypto operations, but valid for math operation.

source

pub fn import_key(key: &[u8 ]) -> Result<Self, Error>

Imports and validates the key. Caller is responsible to zeroize input slice.

source

pub fn check_validity(&self) -> Result<(), Error>

Checks validity of this key.

source

pub fn to_hex(&self) -> String

Wrapper over hex conversion

source

pub fn add(&mut self, other: &Secret) -> Result<(), Error>

Inplace add one secret key to another (scalar + scalar)

source

pub fn sub(&mut self, other: &Secret) -> Result<(), Error>

Inplace subtract one secret key from another (scalar - scalar)

source

pub fn dec(&mut self) -> Result<(), Error>

Inplace decrease secret key (scalar - 1)

source

pub fn mul(&mut self, other: &Secret) -> Result<(), Error>

Inplace multiply one secret key to another (scalar * scalar)

source

pub fn neg(&mut self) -> Result<(), Error>

Inplace negate secret key (-scalar)

source

pub fn pow(&mut self, pow: usize) -> Result<(), Error>

Compute power of secret key inplace (secret ^ pow).

source

pub fn to_secp256k1_secret(&self) -> Result<SecretKey, Error>

Create a secp256k1::key::SecretKey based on this secret. Warning the resulting secret key need to be zeroized manually.

Methods from Deref<Target = H256>

source

pub fn as_bytes(&self) -> &[u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

Extracts a byte slice containing the entire fixed hash.

source

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

Extracts a reference to the byte array containing the entire fixed hash.

source

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

Returns a constant raw pointer to the value.

source

pub fn covers(&self, b: &H256) -> bool

Returns true if all bits set in b are also set in self.

source

pub fn is_zero(&self) -> bool

Returns true if no bits are set.

source

pub fn to_low_u64_be(&self) -> u64

Returns the lowest 8 bytes interpreted as big-endian.

Note

For hash type with less than 8 bytes the missing bytes are interpreted as being zero.

source

pub fn to_low_u64_le(&self) -> u64

Returns the lowest 8 bytes interpreted as little-endian.

Note

For hash type with less than 8 bytes the missing bytes are interpreted as being zero.

source

pub fn to_low_u64_ne(&self) -> u64

Returns the lowest 8 bytes interpreted as native-endian.

Note

For hash type with less than 8 bytes the missing bytes are interpreted as being zero.

Trait Implementations

source

impl Clone for Secret

source

fn clone(&self) -> Secret

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Secret

source

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

Formats the value using the given formatter. Read more

source

impl Deref for Secret

type Target = H256

The resulting type after dereferencing.

source

fn deref(&self) -> &Self::Target

Dereferences the value.

source

impl Display for Secret

source

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

Formats the value using the given formatter. Read more

source

impl Drop for Secret

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl From<[u8 ; 32]> for Secret

source

fn from(k: [u8 ; 32]) -> Self

Performs the conversion.

source

impl From<H256> for Secret

source

fn from(s: H256) -> Self

Performs the conversion.

source

impl From<SecretKey> for Secret

source

fn from(key: SecretKey) -> Self

Performs the conversion.

source

impl FromStr for Secret

type Err = Error

The associated error which can be returned from parsing.

source

fn from_str(s: &str) -> Result<Self, Self::Err>

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

source

impl LowerHex for Secret

source

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

Formats the value using the given formatter.

source

impl PartialEq<Secret> for Secret

source

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

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

source

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

This method tests for !=.

source

impl TryFrom<&'_ [u8 ]> for Secret

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(b: &[u8 ]) -> Result<Self, Error>

Performs the conversion.

source

impl TryFrom<&'_ str> for Secret

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(s: &str) -> Result<Self, Error>

Performs the conversion.

source

impl Eq for Secret

source

impl StructuralEq for Secret

source

impl StructuralPartialEq for Secret

Auto Trait Implementations

impl RefUnwindSafe for Secret

impl Send for Secret

impl Sync for Secret

impl Unpin for Secret

impl UnwindSafe for Secret

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,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

pub default fn to_string(&self) -> String

Converts the given value to a String. 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.

const: unstable · 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.

const: unstable · source

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

Performs the conversion.

source

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

source

Struct parity_crypto::publickey::Secret

Implementations

impl Secret

pub fn copy_from_slice(key: &[u8]) -> Option<Self>

pub fn copy_from_str(s: &str) -> Result<Self, Error>

pub fn zero() -> Self

pub fn import_key(key: &[u8]) -> Result<Self, Error>

pub fn check_validity(&self) -> Result<(), Error>

pub fn to_hex(&self) -> String

pub fn add(&mut self, other: &Secret) -> Result<(), Error>

pub fn sub(&mut self, other: &Secret) -> Result<(), Error>

pub fn dec(&mut self) -> Result<(), Error>

pub fn mul(&mut self, other: &Secret) -> Result<(), Error>

pub fn neg(&mut self) -> Result<(), Error>

pub fn pow(&mut self, pow: usize) -> Result<(), Error>

pub fn to_secp256k1_secret(&self) -> Result<SecretKey, Error>

Methods from Deref<Target = H256>

pub fn as_bytes(&self) -> &[u8]ⓘNotable traits for &'_ mut [u8]impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]

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

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

pub fn covers(&self, b: &H256) -> bool

pub fn is_zero(&self) -> bool

pub fn to_low_u64_be(&self) -> u64

pub fn to_low_u64_le(&self) -> u64

pub fn to_low_u64_ne(&self) -> u64

Trait Implementations

impl Clone for Secret

fn clone(&self) -> Secret

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

impl Debug for Secret

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

impl Deref for Secret

type Target = H256

fn deref(&self) -> &Self::Target

impl Display for Secret

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

impl Drop for Secret

fn drop(&mut self)

impl From<[u8; 32]> for Secret

fn from(k: [u8; 32]) -> Self

impl From<H256> for Secret

fn from(s: H256) -> Self

impl From<SecretKey> for Secret

fn from(key: SecretKey) -> Self

impl FromStr for Secret

type Err = Error

fn from_str(s: &str) -> Result<Self, Self::Err>

impl LowerHex for Secret

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

impl PartialEq<Secret> for Secret

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

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

impl TryFrom<&'_ [u8]> for Secret

type Error = Error

fn try_from(b: &[u8]) -> Result<Self, Error>

impl TryFrom<&'_ str> for Secret

type Error = Error

fn try_from(s: &str) -> Result<Self, Error>

impl Eq for Secret

impl StructuralEq for Secret

impl StructuralPartialEq for Secret

Auto Trait Implementations

impl RefUnwindSafe for Secret

impl Send for Secret

impl Sync for Secret

impl Unpin for Secret

impl UnwindSafe for Secret

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

pub fn copy_from_slice(key: &[u8 ]) -> Option<Self>

pub fn import_key(key: &[u8 ]) -> Result<Self, Error>

pub fn as_bytes(&self) -> &[u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

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

impl From<[u8 ; 32]> for Secret

fn from(k: [u8 ; 32]) -> Self

impl TryFrom<&'_ [u8 ]> for Secret

fn try_from(b: &[u8 ]) -> Result<Self, Error>

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

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

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

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

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,