Enum ApiError 

#[non_exhaustive]
pub enum ApiError {
    InvalidRequest(String),
    Unauthenticated(String),
    AlreadyExists(String),
    Conflict(ApiConflict),
    TaskNotFound(String),
    NotFound(String),
    MethodNotAllowed(String),
    UnsupportedMediaType(String),
    PayloadTooLarge(String),
    ResourceVersionExpired(String),
    Unavailable(String),
    Internal(String),
}

Error returned by the handler or a transport boundary.

Variant	HTTP	gRPC
InvalidRequest	400	InvalidArgument
Unauthenticated	401	Unauthenticated
AlreadyExists	409	AlreadyExists
Conflict	409	Aborted
TaskNotFound, NotFound	404	NotFound
MethodNotAllowed	405	Unimplemented
UnsupportedMediaType	415	InvalidArgument
PayloadTooLarge	413	ResourceExhausted
ResourceVersionExpired	410	OutOfRange
Unavailable	503	Unavailable
Internal	500	Internal

This enum is non-exhaustive. Match it with a wildcard arm.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidRequest(String)

The request is syntactically or semantically invalid.

Unauthenticated(String)

The bearer credential is missing, malformed, or rejected.

AlreadyExists(String)

A retained task already owns the requested name.

Conflict(ApiConflict)

A write precondition does not match the current task.

TaskNotFound(String)

No public task has the requested name.

NotFound(String)

No public resource or route matches the request.

MethodNotAllowed(String)

The resource does not support the requested method.

UnsupportedMediaType(String)

The request media type is missing or unsupported.

PayloadTooLarge(String)

The request body or message exceeds the configured limit.

ResourceVersionExpired(String)

The requested list snapshot or watch position is no longer retained.

Unavailable(String)

The service cannot currently accept work.

Internal(String)

An unexpected server-side failure occurred.

Implementations

impl ApiError

pub fn as_label(&self) -> &'static str

Returns the stable variant label.

Trait Implementations

impl Debug for ApiError

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

Formats the value using the given formatter.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

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

Available on crate feature grpc only.

fn from(err: ApiError) -> Self

Converts to this type from the input type.

impl IntoResponse for ApiError

Available on crate feature http only.

fn into_response(self) -> Response

Create a response.

impl OperationOutput for ApiError

type Inner = Value

The type that is used in examples.

fn operation_response( context: &mut GenContext, _operation: &mut Operation, ) -> Option<ApiResponse>

Return a response documentation for this type, alternatively modify the operation if required.

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation, ) -> Vec<(Option<StatusCode>, Response)>

Inferred responses are used when the type is used as a request handler return type.