Struct cdk::secret::Secret

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

The secret data that allows spending ecash

Implementations

impl Secret

pub fn from_xpriv( xpriv: ExtendedPrivKey, keyset_id: Id, counter: u32, ) -> Result<Self, Error>

Create new Secret from xpriv

impl Secret

pub fn new<S>(secret: S) -> Self

where S: Into<String>,

Create new Secret

pub fn generate() -> Self

Create secret value Generate a new random secret as the recommended 32 byte hex

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

Secret as bytes

pub fn to_bytes(&self) -> Vec<u8>

Secret to bytes

pub fn is_p2pk(&self) -> bool

Check if secret is P2PK secret

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Secret

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Secret

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Secret

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

Formats the value using the given formatter.

impl From<&Secret> for Vec<u8>

fn from(value: &Secret) -> Vec<u8>

Converts to this type from the input type.

impl From<Secret> for Vec<u8>

fn from(value: Secret) -> Vec<u8>

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 Hash for Secret

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Secret

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

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

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

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

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

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

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

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

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

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 Serialize for Secret

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Secret> for Secret

type Error = Error

The type returned in the event of a conversion error.

fn try_from(unchecked_secret: &Secret) -> Result<Secret, Self::Error>

Performs the conversion.

impl TryFrom<&Secret> for SpendingConditions

type Error = Error

The type returned in the event of a conversion error.

fn try_from(secret: &Secret) -> Result<SpendingConditions, Error>

Performs the conversion.

impl TryFrom<Secret> for Secret

type Error = Error

The type returned in the event of a conversion error.

fn try_from(unchecked_secret: Secret) -> Result<Secret, Self::Error>

Performs the conversion.

impl TryFrom<Secret> for Secret

type Error = Error

The type returned in the event of a conversion error.

fn try_from(secret: Secret) -> Result<Secret, Self::Error>

Performs the conversion.

impl Eq for Secret

impl StructuralPartialEq for Secret