Enum MachineReadablePrefix 

#[non_exhaustive]
pub enum MachineReadablePrefix {
    Duplicate,
    Pow,
    Blocked,
    RateLimited,
    Invalid,
    Error,
    Restricted,
    Mute,
    AuthRequired,
    PaymentRequired,
}

Standardised reason prefix used in OK / CLOSED reasons (NIP-20).

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.

Duplicate

duplicate: — the relay already had the event.

Pow

pow: — proof-of-work requirements were not met.

Blocked

blocked: — the author or pubkey is blocked by the relay.

RateLimited

rate-limited: — the client hit a rate limit.

Invalid

invalid: — the event failed validation.

Error

error: — the relay encountered an internal error.

Restricted

restricted: — the author lacks permission (e.g. NIP-42 not done).

Mute

mute: — an ephemeral event nobody was listening to (NIP-01 §OK examples).

AuthRequired

auth-required: — NIP-42 authentication is required.

PaymentRequired

payment-required: — paid relay; the client has not paid yet.

Implementations

impl MachineReadablePrefix

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

Static wire string (without the trailing colon).

pub fn from_reason(reason: &str) -> Option<Self>

Try to extract the prefix from a NIP-20 reason such as "pow: 24". Returns None if the string does not start with a known prefix followed by :.

Trait Implementations

impl Clone for MachineReadablePrefix

fn clone(&self) -> MachineReadablePrefix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MachineReadablePrefix

impl Debug for MachineReadablePrefix

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

Formats the value using the given formatter.

impl Display for MachineReadablePrefix

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

Formats the value using the given formatter.

impl Eq for MachineReadablePrefix

impl FromStr for MachineReadablePrefix

type Err = MachineReadablePrefixError

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 MachineReadablePrefix

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 MachineReadablePrefix

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for MachineReadablePrefix

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