Enum StripeError 

pub enum StripeError {
    Api {
        code: String,
        message: String,
        request_id: String,
    },
    Transport(String),
    SignatureVerification(String),
    Parse(StripeParseError),
    Malformed(String),
}

A failure Stripe reported, or a transport failure on the way there.

Stripe’s REST errors carry a machine-readable code alongside the human message. The request_id is what support asks for, so it is kept as a distinct field rather than being folded into the message.

Variants

Api

Stripe answered with a structured error object.

Fields

code: String

Stripe’s machine-readable error code, such as card_declined.

message: String

Stripe’s human-readable explanation.

request_id: String

The request-id header, which support needs for tracing.

Transport(String)

The request never reached Stripe, or the answer never came back.

SignatureVerification(String)

A webhook signature did not verify.

Parse(StripeParseError)

A core type could not be built from the given input.

Malformed(String)

The response body was not the JSON shape this crate expects.

Implementations

impl StripeError

pub const fn api( code: String, message: String, request_id: String, ) -> StripeError

Build an API error from Stripe’s error envelope.

Arguments

• String - Stripe’s machine-readable error code.
• String - Stripe’s human-readable message.
• String - the request-id header value.

Returns

• Self - the assembled API error.

pub const fn code(&self) -> Option<&str>

Return the machine-readable code when this is an API error.

Returns

• Option<&str> - Stripe’s error code, or None for the transport, parse and signature variants which have no code.

pub const fn request_id(&self) -> Option<&str>

Return the request-id when this is an API error.

Returns

• Option<&str> - the request id to quote to Stripe support, or None when the failure happened before Stripe responded.

pub fn is_retryable(&self) -> bool

Return whether retrying the same request could succeed.

A declined card is a settled answer, so retrying is pointless; a transport failure is not, so callers should back off and repeat.

Returns

• bool - true when the caller should retry with backoff.

Trait Implementations

impl Clone for StripeError

fn clone(&self) -> StripeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StripeError

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

Formats the value using the given formatter.

impl Display for StripeError

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

Formats the value using the given formatter.

impl Eq for StripeError

impl Error for StripeError

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<StripeParseError> for StripeError

fn from(source: StripeParseError) -> StripeError

Converts to this type from the input type.

impl PartialEq for StripeError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StripeError