trait Errors extends AnyRef
Defines the error types used to model client and server errors.
The ClientErrors
type is used by endpoints4s to model errors coming
from the client (missing query parameter, invalid entity, etc.).
The ServerError
type is used by endpoints4s 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.
- Alphabetic
- By Inheritance
- Errors
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
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
Convert the ClientErrors type into the endpoints4s internal client error type
-
abstract
def
invalidToClientErrors(invalid: Invalid): (Errors.this)#ClientErrors
Convert the endpoints4s internal client error type into the ClientErrors type
-
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
Convert the ServerError type into the endpoints4s internal server error type
-
abstract
def
throwableToServerError(throwable: Throwable): (Errors.this)#ServerError
Convert the endpoints4s internal server error type into the ServerError type
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 endpoints4s when decoding a request fails.
Response used by endpoints4s when decoding a request fails.
The provided implementation forwards to
badRequest
. -
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
lazy val
serverErrorResponse: (Errors.this)#Response[(Errors.this)#ServerError]
Response used by endpoints4s when the business logic of an endpoint fails.
Response used by endpoints4s 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(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Types
Types introduced by the algebra
Operations
Operations creating and transforming values