Struct bc::CompressedPk

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

Implementations

impl CompressedPk

pub fn from_byte_array(data: [u8; 33]) -> Result<Self, InvalidPubkey<33>>

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

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

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<<CompressedPk as Wrapper>::Inner> for CompressedPk

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 CompressedPk

fn as_ref(&self) -> &PublicKey

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

impl Borrow<PublicKey> for CompressedPk

fn borrow(&self) -> &PublicKey

Immutably borrows from an owned value.

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

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

Mutably borrows from an owned value.

impl Clone for CompressedPk

fn clone(&self) -> CompressedPk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompressedPk

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

Formats the value using the given formatter.

impl Deref for CompressedPk

type Target = PublicKey

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for CompressedPk

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

Mutably dereferences the value.

impl<'de> Deserialize<'de> for CompressedPk

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CompressedPk

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<CompressedPk> for PubkeyHash

fn from(pk: CompressedPk) -> Self

Converts to this type from the input type.

impl From<CompressedPk> for PublicKey

fn from(wrapped: CompressedPk) -> Self

Converts to this type from the input type.

impl From<CompressedPk> for WPubkeyHash

fn from(pk: CompressedPk) -> Self

Converts to this type from the input type.

impl From<CompressedPk> for XOnlyPk

fn from(pubkey: CompressedPk) -> Self

Converts to this type from the input type.

impl From<PublicKey> for CompressedPk

fn from(v: PublicKey) -> Self

Converts to this type from the input type.

impl FromStr for CompressedPk

type Err = PubkeyParseError<33>

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 CompressedPk

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 CompressedPk

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

Formats the value using the given formatter.

impl Ord for CompressedPk

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

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

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

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 CompressedPk

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

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

impl StrictDumb for CompressedPk

fn strict_dumb() -> Self

impl StrictEncode for CompressedPk

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

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

impl StrictTuple for CompressedPk

const FIELD_COUNT: u8 = 1u8

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for CompressedPk

const STRICT_LIB_NAME: &'static str = LIB_NAME_BITCOIN

fn strict_name() -> Option<TypeName>

impl Wrapper for CompressedPk

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 CompressedPk

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 CompressedPk

impl Eq for CompressedPk

impl StrictProduct for CompressedPk

impl StructuralEq for CompressedPk

impl StructuralPartialEq for CompressedPk