RequestError

A typealias representing the type of error that has occurred. The range of error codes from 100 up to 599 are reserved for HTTP status codes. Custom error codes may be used and must not conflict with this range.

Representation of the error body. May be a type-erased Codable object or a Data (in a particular format).

Creates an error representing the given error code.

Creates an error representing the given error code and reason string.

Creates an error representing the given base error, with a custom response body given as a Codable.

Creates an error respresenting the given base error, with a custom response body given as Data and a BodyFormat.

An error code representing the type of error that has occurred. The range of error codes from 100 up to 599 are reserved for HTTP status codes. Custom error codes may be used and must not conflict with this range.

A human-readable description of the error code.

Representation of the error body - an object representing further details of the failure.

The value may be:

• nil if there is no body
• a (type-erased) Codable object if the error was initialized with init(_:body:)
• bytes of data and a signifier of the format in which they are stored (eg: JSON) if the error was initialized with init(_:bodyData:format:)

Usage example:

if let errorBody = error.body {
    switch error.body {
       case let .codable(body): ... // body is Codable
       case let .data(bytes, format): ... // bytes is Data, format is BodyFormat
    }
}

Returns the Codable error body encoded into bytes in a given format (eg: JSON).

This function should be used if the RequestError was created using init(_:body:), otherwise it will return nil.

Usage Example:

do {
    if let errorBodyData = try error.encodeBody(.json) {
        ...
    }
} catch {
    // Handle the failure to encode
}

Returns the Data error body as the requested Codable type.

This function should be used if the RequestError was created using init(_:bodyData:format:), otherwise it will return nil.

This function throws; you can use bodyAs(_:) instead if you want to ignore DecodingErrors.

Usage Example:

do {
    if let errorBody = try error.decodeBody(MyCodableType.self) {
        ...
    }
} catch {
    // Handle failure to decode
}

Returns the Data error body as the requested Codable type.

This function should be used if the RequestError was created using init(_:bodyData:format:), otherwise it will return nil.

This function ignores DecodingErrors, and returns nil if decoding fails. If you want DecodingErrors to be thrown, use decodeBody(_:) instead.

Usage Example:

if let errorBody = error.bodyAs(MyCodableType.self) {
    ...
}

Returns a Boolean value indicating whether the value of the first argument is less than that of the second argument.

Indicates whether two URLs are the same.

A textual description of the RequestError instance containing the error code and reason.

The computed hash value for the RequestError instance.

The HTTP status code for the error. This value should be a valid HTTP status code if inside the range 100 to 599, however, it may take a value outside that range when representing other types of error.

Creates an error representing a HTTP status code.

HTTP code 100 - Continue

HTTP code 101 - Switching Protocols

HTTP code 200 - OK

HTTP code 201 - Created

HTTP code 202 - Accepted

HTTP code 203 - Non Authoritative Information

HTTP code 204 - No Content

HTTP code 205 - Reset Content

HTTP code 206 - Partial Content

HTTP code 207 - Multi Status

HTTP code 208 - Already Reported

HTTP code 226 - IM Used

HTTP code 300 - Multiple Choices

HTTP code 301 - Moved Permanently

HTTP code 302 - Found

HTTP code 303 - See Other

HTTP code 304 - Not Modified

HTTP code 305 - Use Proxy

HTTP code 307 - Temporary Redirect

HTTP code 308 - Permanent Redirect

HTTP code 400 - Bad Request

HTTP code 401 - Unauthorized

HTTP code 402 - Payment Required

HTTP code 403 - Forbidden

HTTP code 404 - Not Found

HTTP code 405 - Method Not Allowed

HTTP code 406 - Not Acceptable

HTTP code 407 - Proxy Authentication Required

HTTP code 408 - Request Timeout

HTTP code 409 - Conflict

HTTP code 410 - Gone

HTTP code 411 - Length Required

HTTP code 412 - Precondition Failed

HTTP code 413 - Payload Too Large

HTTP code 414 - URI Too Long

HTTP code 415 - Unsupported Media Type

HTTP code 416 - Range Not Satisfiable

HTTP code 417 - Expectation Failed

HTTP code 421 - Misdirected Request

HTTP code 422 - Unprocessable Entity

HTTP code 423 - Locked

HTTP code 424 - Failed Dependency

HTTP code 426 - Upgrade Required

HTTP code 428 - Precondition Required

HTTP code 429 - Too Many Requests

HTTP code 431 - Request Header Fields Too Large

HTTP code 451 - Unavailable For Legal Reasons

HTTP code 500 - Internal Server Error

HTTP code 501 - Not Implemented

HTTP code 502 - Bad Gateway

HTTP code 503 - Service Unavailable

HTTP code 504 - Gateway Timeout

HTTP code 505 - HTTP Version Not Supported

HTTP code 506 - Variant Also Negotiates

HTTP code 507 - Insufficient Storage

HTTP code 508 - Loop Detected

HTTP code 510 - Not Extended

HTTP code 511 - Network Authentication Required