Enum PaykitError 

pub enum PaykitError {
    Transport {
        context: String,
        source: Error,
    },
    NotFound(String),
    InvalidData {
        context: String,
        source: Option<Error>,
    },
    Validation(String),
}

Domain-specific error type.

Variants that wrap an underlying cause carry a source field backed by anyhow::Error so that the standard std::error::Error::source chain is preserved while keeping the public API decoupled from upstream error types. Callers can downcast the source via anyhow::Error::downcast_ref when they need the original typed error.

Variants

Transport

Wrapper for transport layer failures.

Most user-facing failures bubble up through this variant, encapsulating lower-level SDK/network errors (timeouts, connection refused, permission denied, etc.).

Fields

context: String

Human-readable description of what went wrong.

source: Error

The underlying error that caused this failure.

NotFound(String)

The requested resource does not exist.

Returned when a payment endpoint or other resource is not found (404/GONE).

InvalidData

Retrieved data is corrupt or structurally invalid.

Returned when a resource was successfully fetched from the network but its content cannot be interpreted — for example invalid UTF-8 bytes or an unparseable resource path. This is distinct from PaykitError::Transport (the network call itself failed).

Fields

context: String

Human-readable description of the data problem.

source: Option<Error>

The underlying error, when available.

Validation(String)

Input failed validation.

Returned when a caller-supplied value (such as a crate::PaymentEndpointIdentifier) violates structural invariants — for example containing path-traversal sequences, null bytes, or characters outside the allowed set.

Implementations

impl PaykitError

pub fn is_non_retryable_private_send_error(&self) -> bool

Returns true when this error came from a deterministic Encrypted Link private-message send failure that should trigger link recovery instead of ordinary transport retry.

pub fn is_non_retryable_private_receive_error(&self) -> bool

Returns true when this error came from a deterministic Encrypted Link private-message receive failure that should trigger link recovery instead of ordinary transport retry.

Trait Implementations

impl Debug for PaykitError

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

Formats the value using the given formatter.

impl Display for PaykitError

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

Formats the value using the given formatter.

impl Error for PaykitError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl From<PaykitError> for HandshakeAdvanceError

fn from(error: PaykitError) -> Self

Converts to this type from the input type.