Enum ErrorCode 

pub enum ErrorCode {
    BadRequest,
    ValidationFailed,
    Unauthorized,
    InvalidCredentials,
    TokenExpired,
    TokenInvalid,
    Forbidden,
    InsufficientPermissions,
    OrgOutsideSubtree,
    AncestorRequired,
    CrossSubtreeAccess,
    ResourceNotFound,
    MethodNotAllowed,
    NotAcceptable,
    RequestTimeout,
    Conflict,
    ResourceAlreadyExists,
    Gone,
    PreconditionFailed,
    PayloadTooLarge,
    UnsupportedMediaType,
    UnprocessableEntity,
    PreconditionRequired,
    RateLimited,
    RequestHeaderFieldsTooLarge,
    InternalServerError,
    NotImplemented,
    BadGateway,
    ServiceUnavailable,
    GatewayTimeout,
}

Machine-readable error code included in every API error response.

Serializes as a URN per RFC 9457 §3.1.1, which requires the type member to be a URI reference. Format: urn:api-bones:error:<slug> (e.g. urn:api-bones:error:resource-not-found).

Examples

use api_bones::error::ErrorCode;

let code = ErrorCode::ResourceNotFound;
assert_eq!(code.status_code(), 404);
assert_eq!(code.title(), "Resource Not Found");
assert_eq!(code.urn_slug(), "resource-not-found");

Variants

BadRequest

ValidationFailed

Unauthorized

InvalidCredentials

TokenExpired

TokenInvalid

Forbidden

InsufficientPermissions

OrgOutsideSubtree

AncestorRequired

CrossSubtreeAccess

ResourceNotFound

MethodNotAllowed

NotAcceptable

RequestTimeout

Conflict

ResourceAlreadyExists

Gone

PreconditionFailed

PayloadTooLarge

UnsupportedMediaType

UnprocessableEntity

PreconditionRequired

RateLimited

RequestHeaderFieldsTooLarge

InternalServerError

NotImplemented

BadGateway

ServiceUnavailable

GatewayTimeout

Implementations

impl ErrorCode

pub fn status_code(&self) -> u16

HTTP status code for this error code.

Examples

use api_bones::error::ErrorCode;

assert_eq!(ErrorCode::BadRequest.status_code(), 400);
assert_eq!(ErrorCode::Unauthorized.status_code(), 401);
assert_eq!(ErrorCode::InternalServerError.status_code(), 500);

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

Human-friendly title for this error code (RFC 9457 title field).

Examples

use api_bones::error::ErrorCode;

assert_eq!(ErrorCode::ResourceNotFound.title(), "Resource Not Found");
assert_eq!(ErrorCode::BadRequest.title(), "Bad Request");

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

The URN slug for this error code (the part after urn:api-bones:error:).

Examples

use api_bones::error::ErrorCode;

assert_eq!(ErrorCode::ResourceNotFound.urn_slug(), "resource-not-found");
assert_eq!(ErrorCode::ValidationFailed.urn_slug(), "validation-failed");

pub fn urn(&self) -> String

Full type URI for this error code per RFC 9457 §3.1.1.

The format depends on the active ErrorTypeMode (see error_type_mode):

• URL mode: https://docs.myapp.com/errors/resource-not-found
• URN mode: urn:myapp:error:resource-not-found

Requires the std feature (dynamic namespace resolution via error_type_mode).

Examples

use api_bones::error::{ErrorCode, set_error_type_mode, ErrorTypeMode};

set_error_type_mode(ErrorTypeMode::Urn { namespace: "test".into() });
assert_eq!(ErrorCode::ResourceNotFound.urn(), "urn:test:error:resource-not-found");

pub fn from_type_uri(s: &str) -> Option<Self>

Parse an ErrorCode from a type URI string (URL or URN format).

Requires the std feature (dynamic namespace resolution via error_type_mode).

Examples

use api_bones::error::{ErrorCode, set_error_type_mode, ErrorTypeMode};

set_error_type_mode(ErrorTypeMode::Urn { namespace: "test".into() });
let code = ErrorCode::ResourceNotFound;
let uri = code.urn();
assert_eq!(ErrorCode::from_type_uri(&uri), Some(ErrorCode::ResourceNotFound));

Trait Implementations

impl Clone for ErrorCode

fn clone(&self) -> ErrorCode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ErrorCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErrorCode

Available on crate features serde and std only.

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for ErrorCode

Available on crate feature std only.

In std mode the display resolves through the dynamic error_type_mode.

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

Formats the value using the given formatter.

impl From<ErrorCode> for StatusCode

fn from(code: ErrorCode) -> Self

Converts to this type from the input type.

impl PartialEq for ErrorCode

fn eq(&self, other: &ErrorCode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ErrorCode

Available on crate features serde and std only.

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl TryFrom<u16> for ErrorCode

Attempt to convert an HTTP status code (as u16) to its canonical ErrorCode variant.

Only 4xx and 5xx codes that have a direct mapping return Ok; all other codes (1xx, 2xx, 3xx, or unmapped 4xx/5xx) return Err(()).

Examples

use api_bones::error::ErrorCode;

assert_eq!(ErrorCode::try_from(404_u16), Ok(ErrorCode::ResourceNotFound));
assert_eq!(ErrorCode::try_from(500_u16), Ok(ErrorCode::InternalServerError));
assert!(ErrorCode::try_from(200_u16).is_err());
assert!(ErrorCode::try_from(301_u16).is_err());

type Error = ()

The type returned in the event of a conversion error.

fn try_from(status: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ErrorCode

impl StructuralPartialEq for ErrorCode