Struct ApiError 

pub struct ApiError { /* private fields */ }

HTTP error type returned by every control-plane REST handler.

Wraps an HTTP status code and a JSON body (ApiErrorBody). Handlers return Result<_, ApiError> and rely on the axum::response::IntoResponse impl to render the response automatically.

ApiError also implements From<lightshuttle_runtime::LifecycleHandleError>, so the ? operator converts runtime errors into the right HTTP status without boilerplate in each handler.

Three constructors cover all current failure modes:

Constructor	HTTP status	When to use
ApiError::unknown_resource	404	Named resource does not exist
ApiError::not_supported	501	Operation not implemented yet
ApiError::runtime	500	Unexpected runtime failure

Implementations

impl ApiError

pub fn unknown_resource(name: impl Into<String>) -> Self

Build a 404 response for a resource that does not exist.

The serialised body is {"error":"unknown resource","resource":"<name>"}.

Prefer this over constructing ApiError directly so the HTTP status and the error slug remain consistent across all handlers.

pub fn not_supported(op: &'static str) -> Self

Build a 501 response for an operation that is not yet implemented.

The serialised body is {"error":"operation `op` is not supported yet"}.

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

Build a 500 response for an unexpected runtime failure.

The serialised body is {"error":"<message>"}.

Trait Implementations

impl Debug for ApiError

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

Formats the value using the given formatter.

impl From<LifecycleHandleError> for ApiError

fn from(err: LifecycleHandleError) -> Self

Converts to this type from the input type.

impl IntoResponse for ApiError

fn into_response(self) -> Response

Create a response.