RouterFailure

data class RouterFailure @JvmOverloads() constructor(url: URL, routerOrigin: RouterOrigin, message: String, code: Int?, throwable: Throwable?)

Describes a reason for a route request failure.

Parameters

url

original request URL

routerOrigin

router that failed to generate a route

message

message attached to the error code

code

if present, can be either be the HTTP code for offboard requests or an internal error code for onboard requests

throwable

provided if an unexpected exception occurred when creating the request or processing the response

Constructors

RouterFailure
Link copied to clipboard
fun RouterFailure(url: URL, routerOrigin: RouterOrigin, message: String, code: Int? = null, throwable: Throwable? = null)
original request URL

Functions

component1
Link copied to clipboard
operator fun component1(): URL
component2
Link copied to clipboard
operator fun component2(): RouterOrigin
component3
Link copied to clipboard
operator fun component3(): String
component4
Link copied to clipboard
operator fun component4(): Int?
component5
Link copied to clipboard
operator fun component5(): Throwable?
copy
Link copied to clipboard
fun copy(url: URL, routerOrigin: RouterOrigin, message: String, code: Int? = null, throwable: Throwable? = null): RouterFailure
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open override fun hashCode(): Int
toString
Link copied to clipboard
open override fun toString(): String

Properties

code
Link copied to clipboard
val code: Int? = null
if present, can be either be the HTTP code for offboard requests or an internal error code for onboard requests
message
Link copied to clipboard
val message: String
message attached to the error code
routerOrigin
Link copied to clipboard
val routerOrigin: RouterOrigin
router that failed to generate a route
throwable
Link copied to clipboard
val throwable: Throwable? = null
provided if an unexpected exception occurred when creating the request or processing the response
url
Link copied to clipboard
val url: URL
original request URL