Enum ExternalPlatform 

#[non_exhaustive]
pub enum ExternalPlatform {
    GitHub,
    Twitter,
    Mastodon,
    Telegram,
    Other(String),
}

External identity provider.

Well-known platforms have dedicated variants so pattern-matching is concise; unknown ones are preserved verbatim through Self::Other to honour NIP-39’s “SHOULD process any i tags with more than 2 values for future extensibility”.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

GitHub

github — proof is a Gist id under the same username.

Twitter

twitter — proof is a tweet id under the same handle.

Mastodon

mastodon — identity carries <instance>/@<username>; proof is a status id on that instance.

Telegram

telegram — proof is <channel>/<message-id>.

Other(String)

Any other platform name. Per NIP-39 §31 the name MAY contain a-z, 0-9, and ._-/ and MUST NOT contain :. The constructor ExternalPlatform::parse enforces that.

Implementations

impl ExternalPlatform

pub fn parse(name: &str) -> Result<Self, Nip39Error>

Parse a platform name (the part before the colon in <platform>:<identity>).

Errors

• Nip39Error::EmptyPlatform for "".
• Nip39Error::PlatformContainsColon when the name contains the : separator (which would conflate the platform name with the identity).

pub const fn as_str(&self) -> &str

Render the platform back to its canonical wire string.

Trait Implementations

impl Clone for ExternalPlatform

fn clone(&self) -> ExternalPlatform

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalPlatform

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

Formats the value using the given formatter.

impl Display for ExternalPlatform

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

Formats the value using the given formatter.

impl Eq for ExternalPlatform

impl Hash for ExternalPlatform

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 ExternalPlatform

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ExternalPlatform

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ExternalPlatform

fn partial_cmp(&self, other: &ExternalPlatform) -> 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 StructuralPartialEq for ExternalPlatform