Struct cfxkey::Secret

pub struct Secret { /* private fields */ }

Implementations

impl Secret

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

Creates a Secret from the given slice, returning None if the slice length != 32.

pub fn zero() -> Self

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

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

Imports and validates the key.

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

Checks validity of this key.

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

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

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

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

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

Inplace decrease secret key (scalar - 1)

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

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

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

Inplace negate secret key (-scalar)

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

Inplace inverse secret key (1 / scalar)

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

Compute power of secret key inplace (secret ^ pow). This function is not intended to be used with large powers.

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

Create secp256k1::key::SecretKey based on this secret

pub fn to_hex(&self) -> String

Methods from Deref<Target = H256>

pub fn as_bytes(&self) -> &[u8]

Extracts a byte slice containing the entire fixed hash.

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

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

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

Returns a constant raw pointer to the value.

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

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

pub fn is_zero(&self) -> bool

Returns true if no bits are set.

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.

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.

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

impl Clone for Secret

fn clone(&self) -> Secret

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Secret

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

Formats the value using the given formatter.

impl Display for Secret

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

Formats the value using the given formatter.

impl Drop for Secret

fn drop(&mut self)

Executes the destructor for this type.

impl From<&'static str> for Secret

fn from(s: &'static str) -> Self

Converts to this type from the input type.

impl From<[u8; 32]> for Secret

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

Converts to this type from the input type.

impl From<H256> for Secret

fn from(s: H256) -> Self

Converts to this type from the input type.

impl From<SecretKey> for Secret

fn from(key: SecretKey) -> Self

Converts to this type from the input type.

impl FromStr for Secret

type Err = Error

The associated error which can be returned from parsing.

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

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

impl LowerHex for Secret

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

Formats the value using the given formatter.

impl MallocSizeOf for Secret

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl PartialEq for Secret

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Deref for Secret

type Target = H256

The resulting type after dereferencing.

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

Dereferences the value.

impl Eq for Secret

impl StructuralPartialEq for Secret