Struct ApiError 

pub struct ApiError { /* private fields */ }

Protocol-neutral API error envelope.

Implementations

impl ApiError

pub const fn new(code: ErrorCode, message: ErrorMessage) -> Self

Creates an API error envelope.

pub const fn with_category(self, category: ErrorCategory) -> Self

Sets the error category.

pub const fn with_retryable(self, retryable: bool) -> Self

Marks the error as retryable or not retryable.

pub const fn code(&self) -> &ErrorCode

Returns the error code.

pub const fn is_retryable(&self) -> bool

Returns true when retrying may be useful.

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> ApiError

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ApiError

impl StructuralPartialEq for ApiError