Struct PublicKey

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

This is a public key, which identifies an actor (usually a person) and is shared.

Implementations

impl PublicKey

pub fn as_hex_string(&self) -> String

Render into a hexadecimal string

Consider converting .into() a PublicKeyHex which is a wrapped type rather than a naked String

pub fn try_from_hex_string(v: &str, verify: bool) -> Result<PublicKey, Error>

Create from a hexadecimal string

If verify is true, will verify that it works as a XOnlyPublicKey. This has a performance cost.

pub fn as_bech32_string(&self) -> String

Export as a bech32 encoded string

pub fn as_xonly_public_key(&self) -> XOnlyPublicKey

Export as XOnlyPublicKey

pub fn try_from_bech32_string(s: &str, verify: bool) -> Result<PublicKey, Error>

Import from a bech32 encoded string

If verify is true, will verify that it works as a XOnlyPublicKey. This has a performance cost.

pub fn from_bytes(bytes: &[u8], verify: bool) -> Result<PublicKey, Error>

Import from raw bytes

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

Export as raw bytes

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

Export as raw bytes

pub fn verify(&self, message: &[u8], signature: &Signature) -> Result<(), Error>

Verify a signed message

Trait Implementations

impl AsMut<[u8; 32]> for PublicKey

fn as_mut(&mut self) -> &mut [u8; 32]

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

impl AsRef<[u8; 32]> for PublicKey

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

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

impl Clone for PublicKey

fn clone(&self) -> PublicKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PublicKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PublicKey

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&PublicKey> for PublicKeyHex

fn from(pk: &PublicKey) -> PublicKeyHex

Converts to this type from the input type.

impl From<[u8; 32]> for PublicKey

fn from(original: [u8; 32]) -> PublicKey

Converts to this type from the input type.

impl From<PublicKey> for [u8; 32]

fn from(original: PublicKey) -> Self

Converts to this type from the input type.

impl From<PublicKey> for NostrUrl

fn from(p: PublicKey) -> NostrUrl

Converts to this type from the input type.

impl From<PublicKey> for PublicKeyHex

fn from(pk: PublicKey) -> PublicKeyHex

Converts to this type from the input type.

impl Hash for PublicKey

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 PublicKey

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

Restrict a value to a certain interval.

impl PartialEq for PublicKey

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for PublicKey

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for PublicKey

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&PublicKeyHex> for PublicKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(pkh: &PublicKeyHex) -> Result<PublicKey, Error>

Performs the conversion.

impl TryFrom<PublicKeyHex> for PublicKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(pkh: PublicKeyHex) -> Result<PublicKey, Error>

Performs the conversion.

impl Deref for PublicKey

type Target = [u8; 32]

The resulting type after dereferencing.

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

Dereferences the value.

impl Copy for PublicKey

impl Eq for PublicKey

impl StructuralPartialEq for PublicKey