Packages

t

endpoints.sttp.client

BuiltInErrors

trait BuiltInErrors[R[_]] extends algebra.BuiltInErrors

Self Type
BuiltInErrors[R] with EndpointsWithCustomErrors[R]
Source
BuiltInErrors.scala
Known Subclasses
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. BuiltInErrors
  2. BuiltInErrors
  3. Errors
  4. AnyRef
  5. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type ClientErrors = Invalid

    Errors in a request built by a client

    Errors in a request built by a client

    Definition Classes
    BuiltInErrorsErrors
  2. type ServerError = Throwable

    Error raised by the business logic of a server

    Error raised by the business logic of a server

    Definition Classes
    BuiltInErrorsErrors

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def ->[B](y: B): (BuiltInErrors[R], B)
    Implicit
    This member is added by an implicit conversion from BuiltInErrors[R] toArrowAssoc[BuiltInErrors[R]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. lazy val clientErrorsResponse: (BuiltInErrors.this)#Response[(BuiltInErrors.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.

    Definition Classes
    Errors
  7. def clientErrorsResponseEntity: (BuiltInErrors.this)#ResponseEntity[Invalid]

    Response entity format for Invalid values

    Response entity format for Invalid values

    Definition Classes
    BuiltInErrorsBuiltInErrorsErrors
  8. final def clientErrorsToInvalid(clientErrors: (BuiltInErrors.this)#ClientErrors): Invalid

    Convert the ClientErrors type into the endpoints internal client error type

    Convert the ClientErrors type into the endpoints internal client error type

    Definition Classes
    BuiltInErrorsErrors
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def ensuring(cond: (BuiltInErrors[R]) => Boolean, msg: => Any): BuiltInErrors[R]
    Implicit
    This member is added by an implicit conversion from BuiltInErrors[R] toEnsuring[BuiltInErrors[R]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (BuiltInErrors[R]) => Boolean): BuiltInErrors[R]
    Implicit
    This member is added by an implicit conversion from BuiltInErrors[R] toEnsuring[BuiltInErrors[R]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): BuiltInErrors[R]
    Implicit
    This member is added by an implicit conversion from BuiltInErrors[R] toEnsuring[BuiltInErrors[R]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): BuiltInErrors[R]
    Implicit
    This member is added by an implicit conversion from BuiltInErrors[R] toEnsuring[BuiltInErrors[R]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BuiltInErrors[R] toStringFormat[BuiltInErrors[R]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def invalidToClientErrors(invalid: Invalid): (BuiltInErrors.this)#ClientErrors

    Convert the endpoints internal client error type into the ClientErrors type

    Convert the endpoints internal client error type into the ClientErrors type

    Definition Classes
    BuiltInErrorsErrors
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. lazy val serverErrorResponse: (BuiltInErrors.this)#Response[(BuiltInErrors.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

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

    Response entity format for Throwable values

    Response entity format for Throwable values

    Definition Classes
    BuiltInErrorsBuiltInErrorsErrors
  27. final def serverErrorToThrowable(serverError: (BuiltInErrors.this)#ServerError): Throwable

    Convert the ServerError type into the endpoints internal server error type

    Convert the ServerError type into the endpoints internal server error type

    Definition Classes
    BuiltInErrorsErrors
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. final def throwableToServerError(throwable: Throwable): (BuiltInErrors.this)#ServerError

    Convert the endpoints internal server error type into the ServerError type

    Convert the endpoints internal server error type into the ServerError type

    Definition Classes
    BuiltInErrorsErrors
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def [B](y: B): (BuiltInErrors[R], B)
    Implicit
    This member is added by an implicit conversion from BuiltInErrors[R] toArrowAssoc[BuiltInErrors[R]] 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 algebra.BuiltInErrors

Inherited from Errors

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromBuiltInErrors[R] to StringFormat[BuiltInErrors[R]]

Inherited by implicit conversion Ensuring fromBuiltInErrors[R] to Ensuring[BuiltInErrors[R]]

Inherited by implicit conversion ArrowAssoc fromBuiltInErrors[R] to ArrowAssoc[BuiltInErrors[R]]

Types

Types introduced by the algebra

Operations

Operations creating and transforming values

Ungrouped