Errors

Defines the error types used to model client and server errors.

The ClientErrors type is used by endpoints to model errors coming from the client (missing query parameter, invalid entity, etc.).

The ServerError type is used by endpoints to model errors coming from the server business logic.

The badRequest and internalServerError operations defined in Responses define responses carrying entities of type ClientErrors and ServerError, respectively.

Interpreters are expected to use the clientErrorsResponse and serverErrorResponse operations defined here to handle client and server errors, respectively.

Self Type: Errors with Responses
Source: Errors.scala
See also: BuiltInErrors

Linear Supertypes

AnyRef, Any

Known Subclasses

Assets, BasicAuthentication, BuiltInErrors, Endpoints, EndpointsWithCustomErrors, JsonEntities, JsonEntitiesFromCodec, JsonSchemaEntities, LowLevelEndpoints, MuxEndpoints

Type Members

abstract type ClientErrors

Errors in a request built by a client
abstract type ServerError

Error raised by the business logic of a server

Abstract Value Members

abstract def clientErrorsResponseEntity: (Errors.this)#ResponseEntity[(Errors.this)#ClientErrors]

Format of the response entity carrying the client errors.
abstract def clientErrorsToInvalid(clientErrors: (Errors.this)#ClientErrors): Invalid
abstract def invalidToClientErrors(invalid: Invalid): (Errors.this)#ClientErrors
abstract def serverErrorResponseEntity: (Errors.this)#ResponseEntity[(Errors.this)#ServerError]

Format of the response entity carrying the server error.
abstract def serverErrorToThrowable(serverError: (Errors.this)#ServerError): Throwable
abstract def throwableToServerError(throwable: Throwable): (Errors.this)#ServerError

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
lazy val clientErrorsResponse: (Errors.this)#Response[(Errors.this)#ClientErrors]

Response used by the endpoints library when decoding a request fails.
Response used by the endpoints library when decoding a request fails.
The provided implementation forwards to badRequest.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
lazy val serverErrorResponse: (Errors.this)#Response[(Errors.this)#ServerError]

Response used by the endpoints library when the business logic of an endpoint fails.
Response used by the endpoints library when the business logic of an endpoint fails.
The provided implementation forwards to internalServerError
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package algebra

trait Errors extends AnyRef

Type Members

abstract type ClientErrors

abstract type ServerError

Abstract Value Members

abstract def clientErrorsResponseEntity: (Errors.this)#ResponseEntity[(Errors.this)#ClientErrors]

abstract def clientErrorsToInvalid(clientErrors: (Errors.this)#ClientErrors): Invalid

abstract def invalidToClientErrors(invalid: Invalid): (Errors.this)#ClientErrors

abstract def serverErrorResponseEntity: (Errors.this)#ResponseEntity[(Errors.this)#ServerError]

abstract def serverErrorToThrowable(serverError: (Errors.this)#ServerError): Throwable

abstract def throwableToServerError(throwable: Throwable): (Errors.this)#ServerError

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

lazy val clientErrorsResponse: (Errors.this)#Response[(Errors.this)#ClientErrors]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

lazy val serverErrorResponse: (Errors.this)#Response[(Errors.this)#ServerError]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped