Struct ProviderError 

#[non_exhaustive]
pub struct ProviderError {
    pub code: i32,
    pub name: Option<&'static str>,
    pub order_id: Option<OrderId>,
    /* private fields */
}

A provider-declared failed operation.

The provider names every code it publishes, and the same number means different things to different endpoints: code 2 is OrderRejected for /api/Order/place and OrderNotFound for /api/Order/cancel. Self::name carries the published text for the endpoint that produced the rejection.

The provider’s free-form errorMessage is available only through Self::untrusted_message. It never appears in this error’s Display output, and Debug output shows only whether a message is present.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

code: i32

Provider error code.

name: Option<&'static str>

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

Undocumented codes, including codes the provider adds after this crate was published, are None.

order_id: Option<OrderId>

Order record the provider created for a rejected placement, when it returned one.

Only Client::place_order reads this field; every other operation reports None. The record exists on the provider but was not accepted, so it never implies a working order.

Implementations

impl ProviderError

pub fn untrusted_message(&self) -> Option<&str>

Returns the provider’s free-form errorMessage, when it sent one.

The text is untrusted remote input, passed through exactly as the provider sent it: it may contain control characters, terminal escape sequences, markup, line breaks, or account details, and its length is bounded only by the client’s configured response-size limit. Clean or escape it before displaying or logging it. It is None when the provider sent null or omitted the field. Decide the outcome from Self::code, never from this text.

Trait Implementations

impl Clone for ProviderError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProviderError

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

Formats the value using the given formatter.

impl Display for ProviderError

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

Formats the value using the given formatter.

impl Eq for ProviderError

impl Error for ProviderError

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.

impl PartialEq for ProviderError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ProviderError