Enum Error 

#[non_exhaustive]
pub enum Error {
    Configuration(String),
    InvalidIdentifier {
        kind: &'static str,
        reason: &'static str,
    },
    CredentialsRejected {
        code: i32,
        name: Option<&'static str>,
    },
    SessionValidationRejected {
        code: i32,
        name: Option<&'static str>,
    },
    InconsistentResponseStatus {
        success: bool,
        code: i32,
    },
    MissingAuthenticationToken,
    InvalidAuthenticationToken,
    NotAuthenticated,
    AmbiguousSessionValidation,
    Provider(ProviderError),
    Transport(Error),
    UnexpectedStatus {
        status: u16,
    },
    UnexpectedStatusResponse,
    LocallyRateLimited {
        kind: RateLimitKind,
        retry_after: Duration,
    },
    ProviderRateLimited {
        kind: RateLimitKind,
        retry_after: Duration,
    },
    Url(ParseError),
    ResponseTooLarge {
        limit_bytes: usize,
    },
    Decode(Error),
    Encode(Error),
    AmbiguousMutation {
        operation: &'static str,
        code: Option<i32>,
        name: Option<&'static str>,
        origin: Option<AmbiguityOrigin>,
    },
    BackgroundTaskFailed {
        task: &'static str,
    },
}

Errors returned by the ProjectX client.

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.

Configuration(String)

Client configuration was invalid.

InvalidIdentifier

A provider identifier was invalid.

Fields

kind: &'static str

Identifier category.

reason: &'static str

Public-safe reason for rejection.

CredentialsRejected

The provider rejected the supplied authentication credentials.

Fields

code: i32

Public provider rejection code.

name: Option<&'static str>

Provider-published name for code, when /api/Auth/loginKey and /api/Auth/loginApp publish one for it.

SessionValidationRejected

The provider rejected validation of the current session.

Fields

code: i32

Public provider rejection code.

name: Option<&'static str>

Provider-published name for code, when /api/Auth/validate publishes one for it.

InconsistentResponseStatus

The provider’s success flag and required error code disagreed.

The provider did not declare a rejection, so this reports the contradictory pair as received instead of naming a rejection code.

Fields

success: bool

Provider success flag.

code: i32

Provider error code.

MissingAuthenticationToken

A successful authentication response omitted a usable bearer token.

InvalidAuthenticationToken

A provider authentication response contained an invalid bearer token.

NotAuthenticated

No authenticated bearer token is available.

AmbiguousSessionValidation

Session validation may have rotated the provider token, but no trustworthy response was received.

Provider(ProviderError)

The provider rejected an otherwise valid request.

Transport(Error)

The HTTP transport failed.

UnexpectedStatus

The provider returned a non-successful HTTP status.

Fields

status: u16

Numeric HTTP status code.

UnexpectedStatusResponse

The provider status endpoint returned a body other than pong.

LocallyRateLimited

A request was not sent because the shared local budget was exhausted.

Fields

kind: RateLimitKind

Provider budget that rejected local admission.

retry_after: Duration

Minimum time until this client can admit another request.

ProviderRateLimited

The provider rejected an authenticated request with HTTP 429.

Fields

kind: RateLimitKind

Provider budget associated with the rejected endpoint.

retry_after: Duration

Delay from Retry-After, or the configured window when absent.

Url(ParseError)

A URL could not be constructed.

ResponseTooLarge

A provider response exceeded the configured safety limit.

Fields

limit_bytes: usize

Configured response limit.

Decode(Error)

A provider response could not be decoded.

Encode(Error)

A request could not be encoded as JSON.

AmbiguousMutation

A money-moving mutation may have reached the provider but did not produce a trustworthy response.

A decoded provider rejection that is documented as pending, unknown, or otherwise not a definitive rejection stays ambiguous, and carries the provider’s code and published name so the caller can tell OrderPending apart from an unrecognized future code. When no provider rejection was decoded, origin instead carries the transport-level evidence for the ambiguity. Exactly one of code and origin is set in every error this crate constructs: a decoded rejection is the evidence, and otherwise a classified — or explicitly AmbiguityOrigin::Unclassified — origin is.

Fields

operation: &'static str

Public-safe operation name.

code: Option<i32>

Provider error code, when a provider rejection was decoded.

name: Option<&'static str>

Provider-published name for code, when the endpoint’s published error-code table defines it.

origin: Option<AmbiguityOrigin>

Transport-level origin of the ambiguity, when no provider rejection was decoded.

BackgroundTaskFailed

A library-owned background task terminated unexpectedly.

Fields

task: &'static str

Public-safe task name.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

fn from(source: ProviderError) -> Self

Converts to this type from the input type.