Enum ClientError 

pub enum ClientError {
    Sdk(SdkError),
    Http(Error),
    InvalidCredentials,
    ApplicationKeyRequestFailed {
        status: String,
    },
    DecodeFailed {
        url: String,
        status: u16,
        cause: Error,
        payload: String,
    },
    ApiError {
        url: String,
        status: u16,
        message: Option<String>,
        payload: String,
        retry_after: Option<Duration>,
    },
}

Errors that can be returned by LibraryClient operations.

Variants

Sdk(SdkError)

The SDK is not configured or not authenticated.

This variant is produced when DriveThruRpgSdk::library_client is called before the SDK has been configured or before a session has been established.

Http(Error)

An HTTP transport or server error occurred.

This wraps the underlying reqwest::Error including connection failures, timeout errors, and non-success HTTP status codes when .error_for_status() is used.

InvalidCredentials

The provided email or password was rejected by DriveThruRPG.

Returned by credential_login::login_with_credentials when validate_login_credentials.php indicates the credentials are invalid.

ApplicationKeyRequestFailed

Credentials were accepted but the application key request failed.

Returned by credential_login::login_with_credentials when credentials pass validation but create_account_app.php returns a non-success status.

Fields

status: String

The status string returned by create_account_app.php.

DecodeFailed

The HTTP response indicated a successful status but the body could not be deserialized into the expected type.

The raw response body (truncated to [LOG_PAYLOAD_LIMIT] bytes) is preserved so callers can log the offending payload for diagnosis.

Fields

url: String

The URL that was requested.

status: u16

The HTTP status code of the response.

cause: Error

The deserialization error.

payload: String

Raw response body, UTF-8 lossy, truncated to [LOG_PAYLOAD_LIMIT] chars.

ApiError

The API returned a non-success status. message, when present, is a human-readable explanation extracted from the response body (either a top-level message field or field-keyed validation errors, e.g. {"productId": "Requires a valid Product ID. Invalid value 22654728."}).

The raw response body (truncated to [LOG_PAYLOAD_LIMIT] bytes) is preserved so callers can log the offending payload when no message could be extracted.

Fields

url: String

The URL that was requested.

status: u16

The HTTP status code of the response.

message: Option<String>

A human-readable message extracted from the response body, if any.

payload: String

Raw response body, UTF-8 lossy, truncated to [LOG_PAYLOAD_LIMIT] chars.

retry_after: Option<Duration>

The delay specified by the response’s Retry-After header, if present and parseable as a delay-seconds value (RFC 9110 §10.2.3).

Trait Implementations

impl Debug for ClientError

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

Formats the value using the given formatter.

impl Display for ClientError

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

Formats the value using the given formatter.

impl Error for ClientError

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<Error> for ClientError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<SdkError> for ClientError

fn from(err: SdkError) -> Self

Converts to this type from the input type.