Struct bitcoin::util::psbt::raw::ProprietaryKey

pub struct ProprietaryKey<Subtype = ProprietaryType> where
    Subtype: Copy + From<u8> + Into<u8>,  {
    pub prefix: Vec<u8>,
    pub subtype: Subtype,
    pub key: Vec<u8>,
}

Proprietary keys (i.e. keys starting with 0xFC byte) with their internal structure according to BIP 174.

Fields

prefix: Vec<u8>

Proprietary type prefix used for grouping together keys under some application and avoid namespace collision

subtype: Subtype

Custom proprietary subtype

key: Vec<u8>

Additional key bytes (like serialized public key data etc)

Methods

impl<Subtype> ProprietaryKey<Subtype> where
    Subtype: Copy + From<u8> + Into<u8>, 

pub fn from_key(key: Key) -> Result<Self, Error>

Constructs [ProprietaryKey] from [Key]; returns [Error::InvalidProprietaryKey] if key do not starts with 0xFC byte

pub fn to_key(&self) -> Key

Constructs full [Key] corresponding to this proprietary key type

Trait Implementations

impl<Subtype> Encodable for ProprietaryKey<Subtype> where
    Subtype: Copy + From<u8> + Into<u8>, 

fn consensus_encode<W: Write>(&self, e: W) -> Result<usize, Error>

Encode an object with a well-defined format. Returns the number of bytes written on success.

impl<Subtype> Decodable for ProprietaryKey<Subtype> where
    Subtype: Copy + From<u8> + Into<u8>, 

fn consensus_decode<D: Read>(d: D) -> Result<Self, Error>

Decode an object with a well-defined format

impl<Subtype: Ord> Ord for ProprietaryKey<Subtype> where
    Subtype: Copy + From<u8> + Into<u8>, 

fn cmp(&self, other: &ProprietaryKey<Subtype>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl<Subtype: PartialOrd> PartialOrd<ProprietaryKey<Subtype>> for ProprietaryKey<Subtype> where
    Subtype: Copy + From<u8> + Into<u8>, 

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

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

fn lt(&self, other: &ProprietaryKey<Subtype>) -> bool

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

fn le(&self, other: &ProprietaryKey<Subtype>) -> bool

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

fn gt(&self, other: &ProprietaryKey<Subtype>) -> bool

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

fn ge(&self, other: &ProprietaryKey<Subtype>) -> bool

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

impl<Subtype: Clone> Clone for ProprietaryKey<Subtype> where
    Subtype: Copy + From<u8> + Into<u8>, 

fn clone(&self) -> ProprietaryKey<Subtype>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Subtype: PartialEq> PartialEq<ProprietaryKey<Subtype>> for ProprietaryKey<Subtype> where
    Subtype: Copy + From<u8> + Into<u8>, 

fn eq(&self, other: &ProprietaryKey<Subtype>) -> bool

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

fn ne(&self, other: &ProprietaryKey<Subtype>) -> bool

This method tests for !=.

impl<Subtype: Eq> Eq for ProprietaryKey<Subtype> where
    Subtype: Copy + From<u8> + Into<u8>, 

impl<Subtype: Debug> Debug for ProprietaryKey<Subtype> where
    Subtype: Copy + From<u8> + Into<u8>, 

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

Formats the value using the given formatter.

impl<Subtype: Hash> Hash for ProprietaryKey<Subtype> where
    Subtype: Copy + From<u8> + Into<u8>, 

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].