edky 0.1.1

Convert Ed25519 public keys between various encoding formats.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

// This is free and unencumbered software released into the public domain.

use core::str::FromStr;
use derive_more::{Display, FromStrError};

/// A public-key encoding available under the enabled Cargo features.
///
/// [`FromStr`] accepts variant names with ASCII case-insensitive matching and
/// does not allocate. Unknown names and disabled encodings return
/// [`derive_more::FromStrError`]. Whitespace is not trimmed. Format aliases such
/// as `hex` and `iroh` are listed in [`crate::PUBLIC_KEY_FORMATS`] and resolved by
/// the CLI, rather than by this parser.
///
/// Base16 is always available, including without `alloc` or `std`. Other variants
/// are gated by their codec features. [`core::fmt::Display`] uses the variant's
/// spelling, such as `Base16`.
///
/// # Examples
///
/// ```
/// use edky::PublicKeyEncoding;
///
/// assert_eq!("BaSe16".parse(), Ok(PublicKeyEncoding::Base16));
/// assert!("unknown".parse::<PublicKeyEncoding>().is_err());
/// ```
#[derive(Clone, Copy, Debug, Default, Display, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[non_exhaustive]
pub enum PublicKeyEncoding {
    /// Base16 (aka hexadecimal)
    #[default]
    //#[cfg(feature = "base16")]
    Base16,

    /// ASIMOV Protocol
    #[cfg(feature = "base58")]
    Asimov,

    /// Base32z (aka z-base-32, Z32)
    #[cfg(feature = "base32z")]
    Base32z,

    /// Base58 (aka base58-btc)
    #[cfg(feature = "base58")]
    Base58,

    /// Base64
    #[cfg(feature = "base64")]
    Base64,

    /// Base64Url
    #[cfg(feature = "base64")]
    Base64Url,

    /// Multibase
    ///
    /// See: <https://github.com/multiformats/multibase>
    #[cfg(feature = "multibase")]
    Multibase,

    /// NEAR Protocol
    #[cfg(feature = "base58")]
    Near,

    /// OpenSSH Ed25519
    #[cfg(feature = "base64")]
    OpenSsh,
}

impl FromStr for PublicKeyEncoding {
    type Err = FromStrError;

    fn from_str(input: &str) -> Result<Self, Self::Err> {
        Ok(match input {
            input if input.eq_ignore_ascii_case("base16") => Self::Base16,
            #[cfg(feature = "base58")]
            input if input.eq_ignore_ascii_case("asimov") => Self::Asimov,
            #[cfg(feature = "base32z")]
            input if input.eq_ignore_ascii_case("base32z") => Self::Base32z,
            #[cfg(feature = "base58")]
            input if input.eq_ignore_ascii_case("base58") => Self::Base58,
            #[cfg(feature = "base64")]
            input if input.eq_ignore_ascii_case("base64") => Self::Base64,
            #[cfg(feature = "base64")]
            input if input.eq_ignore_ascii_case("base64url") => Self::Base64Url,
            #[cfg(feature = "multibase")]
            input if input.eq_ignore_ascii_case("multibase") => Self::Multibase,
            #[cfg(feature = "base58")]
            input if input.eq_ignore_ascii_case("near") => Self::Near,
            #[cfg(feature = "base64")]
            input if input.eq_ignore_ascii_case("openssh") => Self::OpenSsh,
            _ => return Err(FromStrError::new("PublicKeyEncoding")),
        })
    }
}

impl PublicKeyEncoding {
    /// All encoding variants available under the enabled Cargo features.
    pub const VARIANTS: &'static [Self] = &[
        //#[cfg(feature = "base16")]
        Self::Base16,
        #[cfg(feature = "base58")]
        Self::Asimov,
        #[cfg(feature = "base32z")]
        Self::Base32z,
        #[cfg(feature = "base58")]
        Self::Base58,
        #[cfg(feature = "base64")]
        Self::Base64,
        #[cfg(feature = "base64")]
        Self::Base64Url,
        #[cfg(feature = "multibase")]
        Self::Multibase,
        #[cfg(feature = "base58")]
        Self::Near,
        #[cfg(feature = "base64")]
        Self::OpenSsh,
    ];
}