Packages

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

BuiltInErrors

Linear Supertypes
Known Subclasses
BasicAuthentication, BuiltInErrors, ChunkedEntities, ChunkedJsonEntities, Endpoints, EndpointsWithCustomErrors, JsonEntitiesFromCodecs, JsonEntitiesFromSchemas, MuxEndpoints, BasicAuthentication, BuiltInErrors, ChunkedEntities, ChunkedJsonEntities, Endpoints, EndpointsWithCustomErrors, JsonEntities, JsonEntitiesFromCodecs, JsonEntitiesFromEncodersAndDecoders, JsonEntitiesFromSchemas, MuxEndpoints, Assets, BasicAuthentication, BuiltInErrors, ChunkedEntities, ChunkedJsonEntities, Endpoints, EndpointsWithCustomErrors, JsonCodecs, JsonEntities, JsonEntitiesFromCodecs, JsonEntitiesFromSchemas, LowLevelEndpoints, MuxEndpoints, JsonEntitiesFromCodecs, JsonEntitiesFromCodecs, Assets, BasicAuthentication, BuiltInErrors, Endpoints, EndpointsWithCustomErrors, JsonEntitiesFromCodecs, JsonEntitiesFromEncodersAndDecoders, JsonEntitiesFromSchemas, Assets, BasicAuthentication, BuiltInErrors, ChunkedEntities, ChunkedJsonEntities, Endpoints, EndpointsWithCustomErrors, JsonEntities, JsonEntitiesFromSchemas, MuxEndpoints, BasicAuthentication, BuiltInErrors, Endpoints, EndpointsWithCustomErrors, JsonEntitiesFromCodecs, JsonEntitiesFromSchemas, MuxEndpoints, Assets, BasicAuthentication, BuiltInErrors, ChunkedEntities, ChunkedJsonEntities, Endpoints, EndpointsWithCustomErrors, JsonEntitiesFromCodecs, JsonEntitiesFromEncodersAndDecoders, JsonEntitiesFromSchemas, LowLevelEndpoints, MuxEndpoints, JsonEntities, JsonEntitiesFromCodecs, BasicAuthentication, BuiltInErrors, Endpoints, EndpointsWithCustomErrors, JsonEntitiesFromCodecs, BasicAuthentication, BuiltInErrors, Endpoints, EndpointsWithCustomErrors, JsonEntitiesFromCodecs, MuxEndpoints, Assets, BasicAuthentication, BuiltInErrors, Endpoints, EndpointsWithCustomErrors, JsonEntitiesFromCodecs, JsonEntitiesFromSchemas, LowLevelEndpoints, MuxEndpoints, JsonEntities, Endpoints, MuxEndpoints, Endpoints, EndpointsWithCustomErrors, Endpoints, EndpointsWithCustomErrors, MuxEndpoints
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Errors
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type ClientErrors

    Errors in a request built by a client

  2. abstract type ServerError

    Error raised by the business logic of a server

Abstract Value Members

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

    Format of the response entity carrying the client errors.

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

    Convert the ClientErrors type into the endpoints4s internal client error type

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

    Convert the endpoints4s internal client error type into the ClientErrors type

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

    Format of the response entity carrying the server error.

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

    Convert the ServerError type into the endpoints4s internal server error type

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

    Convert the endpoints4s internal server error type into the ServerError type

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Errors toany2stringadd[Errors] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. 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
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. 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.

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. def ensuring(cond: (Errors) => Boolean, msg: => Any): Errors
    Implicit
    This member is added by an implicit conversion from Errors toEnsuring[Errors] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (Errors) => Boolean): Errors
    Implicit
    This member is added by an implicit conversion from Errors toEnsuring[Errors] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): Errors
    Implicit
    This member is added by an implicit conversion from Errors toEnsuring[Errors] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): Errors
    Implicit
    This member is added by an implicit conversion from Errors toEnsuring[Errors] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. 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
    @inline()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. 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

  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. 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.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromErrors to any2stringadd[Errors]

Inherited by implicit conversion StringFormat fromErrors to StringFormat[Errors]

Inherited by implicit conversion Ensuring fromErrors to Ensuring[Errors]

Inherited by implicit conversion ArrowAssoc fromErrors to ArrowAssoc[Errors]

Types

Types introduced by the algebra

Operations

Operations creating and transforming values

Ungrouped