Struct ApiError 

#[non_exhaustive]
pub struct ApiError {
    pub http_status: Option<u16>,
    pub status: String,
    pub reason: String,
    pub metadata: HashMap<String, String>,
    pub message: String,
    pub request_id: String,
    pub field_violations: Vec<FieldViolation>,
    pub retry_delay: Option<Duration>,
    /* private fields */
}

A call the API refused, or an operation that failed.

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.

http_status: Option<u16>

The response’s HTTP status code; None for an operation’s error.

status: String

The closest canonical code, such as NOT_FOUND, for generic tooling.

reason: String

The platform’s error code, such as NOT_FOUND or CONFLICT: what to branch on.

metadata: HashMap<String, String>

More about the reason, by name, such as serviceAccount, the name of the service account an earlier request with the same request id created; empty when the API sends none.

message: String

What went wrong, for a person.

request_id: String

Identifies the request to Origin Cloud’s support.

field_violations: Vec<FieldViolation>

The request fields that were refused.

retry_delay: Option<Duration>

How long the API asks to wait before trying again; None when it doesn’t ask.

Implementations

impl ApiError

pub fn is_retryable(&self) -> bool

Whether the API answered that the same call may succeed if it is sent again.

Trait Implementations

impl Clone for ApiError

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 ApiError

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

Formats the value using the given formatter.

impl Default for ApiError

fn default() -> Self

Returns the “default value” for a type.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

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

fn from(e: ApiError) -> Self

Converts to this type from the input type.

impl PartialEq for ApiError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ApiError