Struct PublicKey

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

Available on crate feature ed25519 only.

Implementations

impl PublicKey

pub const MULTICODEC_TYPE: [u8; 2]

Available on crate feature multibase only.

Multicodec key type for Ed25519 keys.

pub fn to_human_readable(&self) -> String

Available on crate feature multibase only.

Encode public key in human-readable format.

We use the format specified by the DID key method, which is described as:

did:key:MULTIBASE(base58-btc, MULTICODEC(public-key-type, raw-public-key-bytes))

impl PublicKey

pub fn from_pem(pem: &str) -> Result<Self, Error>

Available on crate feature pem only.

pub fn from_der(der: &[u8]) -> Result<Self, Error>

Available on crate feature pem only.

pub fn to_pem(&self) -> String

Available on crate feature pem only.

Methods from Deref<Target = PublicKey>

pub const BYTES: usize = 32usize

pub fn verify_incremental( &self, signature: &Signature, ) -> Result<VerifyingState, Error>

Verify the signature of a multi-part message (streaming).

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

Verifies that the signature signature is valid for the message message.

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

Export a public key as an OpenSSL-compatible DER file.

pub fn to_pem(&self) -> String

Export a public key as an OpenSSL-compatible PEM file.

Trait Implementations

impl AsRef<PublicKey> for PublicKey

fn as_ref(&self) -> &PublicKey

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

impl Borrow<PublicKey> for PublicKey

fn borrow(&self) -> &PublicKey

Immutably borrows from an owned value.

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

type Target = PublicKey

The resulting type after dereferencing.

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

Dereferences the value.

impl Display for PublicKey

Available on crate feature multibase only.

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

Formats the value using the given formatter.

impl EcPk for PublicKey

const COMPRESSED_LEN: usize = 32usize

const CURVE_NAME: &'static str = "Edwards25519"

type Compressed = [u8; 32]

fn base_point() -> Self

fn to_pk_compressed(&self) -> Self::Compressed

fn from_pk_compressed(pk: Self::Compressed) -> Result<Self, EcPkInvalid>

fn from_pk_compressed_slice(slice: &[u8]) -> Result<Self, EcPkInvalid>

impl From<PublicKey> for PublicKey

fn from(wrapped: PublicKey) -> Self

Converts to this type from the input type.

impl From<PublicKey> for PublicKey

fn from(v: PublicKey) -> Self

Converts to this type from the input type.

impl From<PublicKey> for String

Available on crate feature multibase only.

fn from(other: PublicKey) -> Self

Converts to this type from the input type.

impl FromStr for PublicKey

Available on crate feature multibase only.

type Err = EcSerError

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 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 MultiDisplay<Encoding> for PublicKey

type Display = String

fn display_fmt(&self, f: &Encoding) -> Self::Display

impl Ord for PublicKey

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

Available on crate feature multibase only.

type Error = EcSerError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Wrapper for PublicKey

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

impl Eq for PublicKey

impl StructuralPartialEq for PublicKey