Struct PublicKey

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

Public key of an account on chain. Usually created along with a SecretKey to form a keypair associated to the account.

Implementations

impl PublicKey

pub fn empty(key_type: KeyType) -> Self

Create an empty PublicKey with the given KeyType. This is a zero-ed out public key with the length of the bytes determined by the associated key type.

pub fn try_from_parts(key_type: KeyType, bytes: &[u8]) -> Result<Self>

Create a new PublicKey from the given bytes. This will return an error if the bytes are not in the correct format. Expected to have key type be the first byte encoded, with the remaining bytes being the key data.

pub fn len(&self) -> usize

Get the number of bytes this key uses. This will differ depending on the KeyType. i.e. for ED25519 keys, this will return 32 + 1, while for SECP256K1 keys, this will return 64 + 1. The +1 is used to store the key type, and will appear at the start of the serialized key.

pub fn key_type(&self) -> KeyType

Get the KeyType of the public key.

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

Get the key data of the public key. This is serialized bytes of the public key. This will not include the key type, and will only contain the raw key data.

Trait Implementations

impl BorshDeserialize for PublicKey

fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for PublicKey

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

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 Display for PublicKey

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

Formats the value using the given formatter.

impl From<PublicKey> for PublicKey

fn from(pk: PublicKey) -> Self

Converts to this type from the input type.

impl FromStr for PublicKey

type Err = Error

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this 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 Eq for PublicKey

impl StructuralPartialEq for PublicKey