Enum OpClientError

pub enum OpClientError {
    Http(String),
    HeaderParse(String),
    Serde(Error),
    Io(Error),
    Pem(String),
    Pkcs8(String),
    Base64(DecodeError),
    Url(ParseError),
    Signature(String),
    Other(String),
}

Error type for Open Payments client operations.

This enum provides detailed error information for different types of failures that can occur during client operations. Each variant includes context-specific error messages to help with debugging and error handling.

Error Variants

• Http - Network and HTTP protocol errors
• HeaderParse - HTTP header parsing failures
• Serde - JSON serialization/deserialization errors
• Io - File system and I/O errors
• Pem - PEM format parsing errors
• Pkcs8 - PKCS8 key format errors
• Base64 - Base64 encoding/decoding errors
• Url - URL parsing errors
• Signature - Cryptographic signature errors
• Other - Miscellaneous errors

Variants

Http(String)

HTTP protocol or network-related errors.

This includes connection failures, timeout errors, and HTTP status code errors. The error message provides details about the specific HTTP issue.

HeaderParse(String)

HTTP header parsing errors.

Occurs when the client cannot parse required HTTP headers such as Content-Type, Authorization, or custom headers.

Serde(Error)

JSON serialization or deserialization errors.

This error is automatically converted from serde_json::Error and occurs when the client cannot serialize request data or deserialize response data.

Io(Error)

File system and I/O errors.

This error is automatically converted from std::io::Error and occurs when the client cannot read key files or perform other I/O operations.

Pem(String)

PEM format parsing errors.

Occurs when the client cannot parse PEM-encoded private keys or certificates. This includes malformed PEM files or unsupported PEM types.

Pkcs8(String)

PKCS8 key format errors.

Occurs when the client cannot parse PKCS8-encoded private keys. This includes unsupported key algorithms or malformed key data.

Base64(DecodeError)

Base64 encoding or decoding errors.

This error is automatically converted from base64::DecodeError and occurs when the client cannot decode Base64-encoded data such as signatures or keys.

Url(ParseError)

URL parsing errors.

This error is automatically converted from url::ParseError and occurs when the client cannot parse URLs for wallet addresses or API endpoints.

Signature(String)

Cryptographic signature errors.

Occurs when there are issues with HTTP message signature creation or validation. This includes key loading failures, signature generation errors, and validation failures.

Other(String)

Miscellaneous errors that don’t fit into other categories.

This variant is used for unexpected errors that don’t fall into the standard error categories.

Trait Implementations

impl Debug for OpClientError

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

Formats the value using the given formatter.

impl Display for OpClientError

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

Formats the value using the given formatter.

impl Error for OpClientError

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<DecodeError> for OpClientError

fn from(source: DecodeError) -> Self

Converts to this type from the input type.

impl From<Error> for OpClientError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for OpClientError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for OpClientError

fn from(err: Error) -> Self

Converts reqwest HTTP errors to OpClientError::Http.

This implementation allows the client to automatically convert reqwest errors into the unified error type, providing consistent error handling across the library.

impl From<ParseError> for OpClientError

fn from(source: ParseError) -> Self

Converts to this type from the input type.