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.
- Self Type
- Errors with Responses
- Source
- Errors.scala
- See also
- Grouped
- Alphabetic
- By Inheritance
- Errors
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
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
- def +(other: String): String
- def ->[B](y: B): (Errors, B)
- 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(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def ensuring(cond: (Errors) => Boolean, msg: => Any): Errors
- def ensuring(cond: (Errors) => Boolean): Errors
- def ensuring(cond: Boolean, msg: => Any): Errors
- def ensuring(cond: Boolean): Errors
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- 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
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- 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(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Errors toStringFormat[Errors] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (Errors, B)
- Implicit
- This member is added by an implicit conversion from Errors toArrowAssoc[Errors] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Types
Types introduced by the algebra
Operations
Operations creating and transforming values