Enum PlatformApiError 

pub enum PlatformApiError {
    HttpError(Error),
    ApiError {
        status: u16,
        message: String,
    },
    ParseError(String),
    Unauthorized,
    NotFound(String),
    PermissionDenied(String),
    RateLimited,
    ServerError {
        status: u16,
        message: String,
    },
    ConnectionFailed,
}

Errors that can occur when interacting with the Syncable Platform API

Variants

HttpError(Error)

HTTP request failed (network error, timeout, etc.)

ApiError

API returned an error response

Fields

status: u16

HTTP status code

message: String

Error message from the API

ParseError(String)

Failed to parse the API response

Unauthorized

User is not authenticated - needs to run sync-ctl auth login

NotFound(String)

Requested resource was not found

PermissionDenied(String)

User does not have permission for the requested operation

RateLimited

Rate limit exceeded

ServerError

Server error

Fields

status: u16

HTTP status code (5xx)

message: String

Error message

ConnectionFailed

Could not connect to the Syncable API

Implementations

impl PlatformApiError

pub fn suggestion(&self) -> Option<&'static str>

Get a user-friendly suggestion for resolving this error

Returns actionable advice that helps users fix the issue.

pub fn with_suggestion(&self) -> String

Format the error with suggestion if available

Returns the error message followed by a suggestion on how to resolve it.

Trait Implementations

impl Debug for PlatformApiError

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

Formats the value using the given formatter.

impl Display for PlatformApiError

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

Formats the value using the given formatter.

impl Error for PlatformApiError

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

fn from(source: Error) -> Self

Converts to this type from the input type.