Packages

t

endpoints4s.algebra

BuiltInErrors

trait BuiltInErrors extends Errors

Interpreter for the Errors algebra that uses endpoints4s built-in error types:

  • Invalid for client errors,
  • and Throwable for server error.

Both types of errors are serialized into a JSON array containing string error values.

Self Type
BuiltInErrors with EndpointsWithCustomErrors
Linear Supertypes
Errors, AnyRef, Any
Known Subclasses
Endpoints
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BuiltInErrors
  2. Errors
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type ClientErrors = Invalid

    Errors in a request built by a client

    Errors in a request built by a client

    Definition Classes
    BuiltInErrors → Errors
  2. type ServerError = Throwable

    Error raised by the business logic of a server

    Error raised by the business logic of a server

    Definition Classes
    BuiltInErrors → Errors

Abstract Value Members

  1. abstract def clientErrorsResponseEntity: (BuiltInErrors.this)#ResponseEntity[Invalid]

    Response entity format for Invalid values

    Response entity format for Invalid values

    Definition Classes
    BuiltInErrors → Errors
  2. abstract def serverErrorResponseEntity: (BuiltInErrors.this)#ResponseEntity[Throwable]

    Response entity format for Throwable values

    Response entity format for Throwable values

    Definition Classes
    BuiltInErrors → Errors

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. lazy val clientErrorsResponse: (BuiltInErrors.this)#Response[(BuiltInErrors.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.

    Definition Classes
    Errors
  6. final def clientErrorsToInvalid(clientErrors: (BuiltInErrors.this)#ClientErrors): Invalid

    Convert the ClientErrors type into the endpoints4s internal client error type

    Convert the ClientErrors type into the endpoints4s internal client error type

    Definition Classes
    BuiltInErrors → Errors
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def invalidToClientErrors(invalid: Invalid): (BuiltInErrors.this)#ClientErrors

    Convert the endpoints4s internal client error type into the ClientErrors type

    Convert the endpoints4s internal client error type into the ClientErrors type

    Definition Classes
    BuiltInErrors → Errors
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. lazy val serverErrorResponse: (BuiltInErrors.this)#Response[(BuiltInErrors.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

    Definition Classes
    Errors
  18. final def serverErrorToThrowable(serverError: (BuiltInErrors.this)#ServerError): Throwable

    Convert the ServerError type into the endpoints4s internal server error type

    Convert the ServerError type into the endpoints4s internal server error type

    Definition Classes
    BuiltInErrors → Errors
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. final def throwableToServerError(throwable: Throwable): (BuiltInErrors.this)#ServerError

    Convert the endpoints4s internal server error type into the ServerError type

    Convert the endpoints4s internal server error type into the ServerError type

    Definition Classes
    BuiltInErrors → Errors
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Errors

Inherited from AnyRef

Inherited from Any

Types

Types introduced by the algebra

Operations

Operations creating and transforming values

Ungrouped