Struct bc::LegacyPk

pub struct LegacyPk {
    pub compressed: bool,
    pub pubkey: PublicKey,
}

Fields

compressed: bool

pubkey: PublicKey

Implementations

impl LegacyPk

pub const fn compressed(pubkey: PublicKey) -> Self

pub const fn uncompressed(pubkey: PublicKey) -> Self

pub fn from_bytes(bytes: impl AsRef<[u8]>) -> Result<Self, InvalidPubkey<65>>

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

Methods from Deref<Target = PublicKey>

pub fn cmp_fast_unstable(&self, other: &PublicKey) -> Ordering

Like cmp::Cmp but faster and with no guarantees across library versions.

The Cmp implementation for FFI types is stable but slow because it first serializes self and other before comparing them. This function provides a faster comparison if you know that your types come from the same library version.

pub fn eq_fast_unstable(&self, other: &PublicKey) -> bool

Like cmp::Eq but faster and with no guarantees across library versions.

The Eq implementation for FFI types is stable but slow because it first serializes self and other before comparing them. This function provides a faster equality check if you know that your types come from the same library version.

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

👎Deprecated since 0.25.0: Use Self::as_c_ptr if you need to access the FFI layer

Obtains a raw const pointer suitable for use with FFI functions.

pub fn as_mut_ptr(&mut self) -> *mut PublicKey

👎Deprecated since 0.25.0: Use Self::as_mut_c_ptr if you need to access the FFI layer

Obtains a raw mutable pointer suitable for use with FFI functions.

pub fn serialize(&self) -> [u8; 33]

Serializes the key as a byte-encoded pair of values. In compressed form the y-coordinate is represented by only a single bit, as x determines it up to one bit.

pub fn serialize_uncompressed(&self) -> [u8; 65]

Serializes the key as a byte-encoded pair of values, in uncompressed form.

pub fn combine(&self, other: &PublicKey) -> Result<PublicKey, Error>

Adds a second key to this one, returning the sum.

Errors

If the result would be the point at infinity, i.e. adding this point to its own negation.

Examples

use secp256k1::{rand, Secp256k1};

let secp = Secp256k1::new();
let mut rng = rand::thread_rng();
let (_, pk1) = secp.generate_keypair(&mut rng);
let (_, pk2) = secp.generate_keypair(&mut rng);
let sum = pk1.combine(&pk2).expect("It's improbable to fail for 2 random public keys");

pub fn x_only_public_key(&self) -> (XOnlyPublicKey, Parity)

Returns the XOnlyPublicKey (and it’s Parity) for this PublicKey.

Trait Implementations

impl AsMut<<LegacyPk as Wrapper>::Inner> for LegacyPk

fn as_mut(&mut self) -> &mut <Self as Wrapper>::Inner

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<PublicKey> for LegacyPk

fn as_ref(&self) -> &PublicKey

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<PublicKey> for LegacyPk

fn borrow(&self) -> &PublicKey

Immutably borrows from an owned value.

impl BorrowMut<<LegacyPk as Wrapper>::Inner> for LegacyPk

fn borrow_mut(&mut self) -> &mut <Self as Wrapper>::Inner

Mutably borrows from an owned value.

impl Clone for LegacyPk

fn clone(&self) -> LegacyPk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LegacyPk

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

Formats the value using the given formatter.

impl Deref for LegacyPk

type Target = PublicKey

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for LegacyPk

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for LegacyPk

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LegacyPk

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

Formats the value using the given formatter.

impl From<CompressedPk> for LegacyPk

fn from(pk: CompressedPk) -> Self

Converts to this type from the input type.

impl From<LegacyPk> for PubkeyHash

fn from(pk: LegacyPk) -> Self

Converts to this type from the input type.

impl From<LegacyPk> for PublicKey

fn from(wrapped: LegacyPk) -> Self

Converts to this type from the input type.

impl From<PublicKey> for LegacyPk

fn from(pk: PublicKey) -> Self

Converts to this type from the input type.

impl From<UncompressedPk> for LegacyPk

fn from(pk: UncompressedPk) -> Self

Converts to this type from the input type.

impl FromStr for LegacyPk

type Err = PubkeyParseError<65>

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 LegacyPk

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 LowerHex for LegacyPk

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

Formats the value using the given formatter.

impl Ord for LegacyPk

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

fn eq(&self, other: &LegacyPk) -> 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 LegacyPk

fn partial_cmp(&self, other: &LegacyPk) -> 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 LegacyPk

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StrictDecode for LegacyPk

fn strict_decode(reader: &mut impl TypedRead) -> Result<Self, DecodeError>

fn strict_read(lim: usize, reader: impl Read) -> Result<Self, DecodeError>

impl StrictDumb for LegacyPk

fn strict_dumb() -> Self

impl StrictEncode for LegacyPk

fn strict_encode<W: TypedWrite>(&self, writer: W) -> Result<W>

fn strict_write(&self, lim: usize, writer: impl Write) -> Result<usize, Error>

impl StrictStruct for LegacyPk

const ALL_FIELDS: &'static [&'static str] = _

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for LegacyPk

const STRICT_LIB_NAME: &'static str = LIB_NAME_BITCOIN

fn strict_name() -> Option<TypeName>

impl Wrapper for LegacyPk

type Inner = PublicKey

Inner type wrapped by the current newtype

fn from_inner(inner: Self::Inner) -> Self

Instantiates wrapper type with the inner data

fn as_inner(&self) -> &Self::Inner

Returns reference to the inner representation for the wrapper type

fn into_inner(self) -> Self::Inner

Unwraps the wrapper returning the inner type

fn to_inner(&self) -> Self::Inner

where Self::Inner: Clone,

Clones inner data of the wrapped type and return them

fn copy(&self) -> Self

where Self: Sized, Self::Inner: Copy,

Copies the wrapped type

impl WrapperMut for LegacyPk

fn as_inner_mut(&mut self) -> &mut <Self as Wrapper>::Inner

Returns a mutable reference to the inner representation for the wrapper type

impl Copy for LegacyPk

impl Eq for LegacyPk

impl StrictProduct for LegacyPk

impl StructuralEq for LegacyPk

impl StructuralPartialEq for LegacyPk