Struct Multikey 

#[non_exhaustive]
pub struct Multikey {
    pub encoded: String,
    pub key: Ed25519PublicKey,
}

A FEP-521a Multikey, pairing the decoded VerifyingKey with the original base58-btc encoded string.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

encoded: String

The original z<base58-btc> encoded string.

key: Ed25519PublicKey

Decoded Ed25519 public key.

Implementations

impl Multikey

pub fn encode_ed25519(key: &Ed25519PublicKey) -> String

Encodes an Ed25519 public key as a z<base58-btc> Multikey string.

pub fn decode(encoded: &str) -> Result<Self, Error>

Decodes a Multikey string into its components.

Errors

Returns Error::InvalidMultibase on bad multibase encoding, Error::InvalidMultikeyPrefix when the varint prefix is missing, Error::UnsupportedAlgorithm when the codec is not Ed25519, and Error::InvalidMultikeyLength when the body is the wrong length.

Trait Implementations

impl Clone for Multikey

fn clone(&self) -> Multikey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Multikey

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

Formats the value using the given formatter.

impl PartialEq for Multikey

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

impl StructuralPartialEq for Multikey