Enum RestError 

pub enum RestError {
    RestApiDisabled,
    InvalidPath {
        path: String,
    },
    Http(HttpError),
}

Error type for REST API operations.

This enum provides specific error types for REST API operations, wrapping HTTP errors and adding REST-specific error cases.

Example

use shopify_sdk::clients::rest::RestError;

// REST API disabled error
let error = RestError::RestApiDisabled;
assert!(error.to_string().contains("deprecated"));

// Invalid path error
let error = RestError::InvalidPath { path: "".to_string() };
assert!(error.to_string().contains("Invalid"));

Variants

RestApiDisabled

The REST Admin API has been deprecated and is disabled.

This error is returned when the REST API is disabled in the SDK configuration, indicating that users should migrate to GraphQL.

InvalidPath

The REST API path is invalid.

This error is returned when a path fails validation, such as when it is empty after normalization.

Fields

path: String

The invalid path that was provided.

Http(HttpError)

An HTTP-level error occurred.

This variant wraps HttpError for unified error handling.

Trait Implementations

impl Debug for RestError

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

Formats the value using the given formatter.

impl Display for RestError

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

Formats the value using the given formatter.

impl Error for RestError

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<HttpError> for RestError

fn from(source: HttpError) -> Self

Converts to this type from the input type.

impl From<RestError> for ResourceError

fn from(source: RestError) -> Self

Converts to this type from the input type.