Enum VerifyResponse 

#[non_exhaustive]
pub enum VerifyResponse {
    Valid {
        payer: Option<CompactString>,
        extensions: Extensions,
        extension_responses: Extensions,
        extra: Option<Value>,
    },
    Invalid {
        reason: Option<ErrorReason>,
        message: Option<CompactString>,
        payer: Option<CompactString>,
        extensions: Extensions,
        extension_responses: Extensions,
        extra: Option<Value>,
    },
}

Verification outcome returned by a facilitator.

extension_responses is the EXTENSION-RESPONSES sidechannel. It is not serialized into JSON and is never merged into extensions.

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.

Valid

Payload passed all verification checks.

Fields

payer: Option<CompactString>

Address of the verified payer, if the facilitator included it.

extensions: Extensions

Facilitator-attached extension data (JSON body).

extension_responses: Extensions

Facilitator EXTENSION-RESPONSES sidechannel. Not buyer wire.

extra: Option<Value>

Scheme-specific additional data.

Invalid

Payload was well-formed but failed verification.

Fields

reason: Option<ErrorReason>

Wire-level reason code, if the facilitator included it.

message: Option<CompactString>

Optional human-readable message.

payer: Option<CompactString>

Optional payer address if identifiable from the payload.

extensions: Extensions

Facilitator-attached extension data (JSON body).

extension_responses: Extensions

Facilitator EXTENSION-RESPONSES sidechannel. Not buyer wire.

extra: Option<Value>

Scheme-specific additional data.

Implementations

impl VerifyResponse

pub fn valid(payer: impl Into<CompactString>) -> Self

Valid response with empty extensions.

pub fn invalid(payer: Option<CompactString>, reason: ErrorReason) -> Self

Invalid response without a human message.

pub fn invalid_with_message( payer: Option<CompactString>, reason: ErrorReason, message: impl Into<CompactString>, ) -> Self

Invalid response with a message.

pub const fn is_valid(&self) -> bool

Whether this is a Valid outcome.

pub const fn extension_responses(&self) -> &Extensions

Sidechannel map (empty when the header was absent).

pub fn set_extension_responses(&mut self, responses: Extensions)

Replaces the sidechannel map.

pub fn from_facilitator_error(error: &FacilitatorError) -> Option<Self>

Converts a FacilitatorError into an Invalid response.

Returns None for FacilitatorError::Transport: that is HTTP 502, not a 402 body.

Trait Implementations

impl Clone for VerifyResponse

fn clone(&self) -> VerifyResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VerifyResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VerifyResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for VerifyResponse

impl PartialEq for VerifyResponse

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for VerifyResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for VerifyResponse