Enum GhostError 

pub enum GhostError {
    Api {
        message: String,
        error_type: String,
        context: Option<String>,
    },
    Http(Error),
    Json(Error),
    Auth(String),
}

The error type for Ghost API operations.

This enum represents all possible errors that can occur when interacting with the Ghost API, including network errors, serialization errors, API errors, and authentication errors.

Variants

Api

An error returned by the Ghost API.

Ghost returns structured JSON errors with a message, error type, and optional context information.

Fields

message: String

The human-readable error message.

error_type: String

The error type identifier (e.g., “NotFoundError”, “ValidationError”).

context: Option<String>

Optional additional context about the error.

Http(Error)

An HTTP error from the underlying HTTP client.

This includes network errors, connection timeouts, DNS resolution failures, and HTTP status code errors.

Json(Error)

A JSON serialization or deserialization error.

This occurs when the response from Ghost cannot be parsed or when a request body cannot be serialized.

Auth(String)

An authentication error.

This includes JWT generation failures, invalid API keys, or other authentication-related issues.

Implementations

impl GhostError

pub fn api( message: impl Into<String>, error_type: impl Into<String>, context: Option<String>, ) -> Self

Creates a new API error with the given message and error type.

Examples

use ghost_io_api::error::GhostError;

let error = GhostError::api(
    "Resource not found",
    "NotFoundError",
    None,
);

pub fn auth(message: impl Into<String>) -> Self

Creates a new authentication error.

Examples

use ghost_io_api::error::GhostError;

let error = GhostError::auth("Invalid API key");

pub fn is_api_error(&self) -> bool

Returns true if this is an API error.

Examples

use ghost_io_api::error::GhostError;

let error = GhostError::api("Not found", "NotFoundError", None);
assert!(error.is_api_error());

pub fn is_http_error(&self) -> bool

Returns true if this is an HTTP error.

pub fn is_json_error(&self) -> bool

Returns true if this is a JSON serialization error.

pub fn is_auth_error(&self) -> bool

Returns true if this is an authentication error.

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

Returns the error type for API errors.

Returns None for non-API errors.

Examples

use ghost_io_api::error::GhostError;

let error = GhostError::api("Not found", "NotFoundError", None);
assert_eq!(error.api_error_type(), Some("NotFoundError"));

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

Returns the error message for API errors.

Returns None for non-API errors.

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

Returns the context for API errors.

Returns None for non-API errors or if no context is available.

Trait Implementations

impl Debug for GhostError

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

Formats the value using the given formatter.

impl Display for GhostError

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

Formats the value using the given formatter.

impl Error for GhostError

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 GhostError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for GhostError

fn from(source: Error) -> Self

Converts to this type from the input type.