trait Responses extends algebra.Responses with Errors with StatusCodes

Linear Supertypes
StatusCodes, Errors, algebra.Responses, endpoints.InvariantFunctorSyntax, algebra.StatusCodes, AnyRef, Any
Known Subclasses
Assets, BasicAuthentication, Endpoints, EndpointsWithCustomErrors, JsonEntitiesFromCodecs, JsonEntitiesFromEncodersAndDecoders, JsonEntitiesFromSchemas
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Responses
  2. StatusCodes
  3. Errors
  4. Responses
  5. InvariantFunctorSyntax
  6. StatusCodes
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type ClientErrors
    Definition Classes
    Errors
  2. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  3. type Response[A] = (A) => RIO[Blocking, uzhttp.Response]

    An HTTP response (status, headers, and entity) carrying an information of type A

    An HTTP response (status, headers, and entity) carrying an information of type A

    Definition Classes
    Responses → Responses
    Note

    This type has implicit methods provided by the InvariantFunctorSyntax and ResponseSyntax class

  4. type ResponseEntity[A] = (A) => (Array[Byte], String)

    An HTTP response entity carrying an information of type A It is modeled as function that receives A and returns it value serialized to byte array together with content type.

    An HTTP response entity carrying an information of type A It is modeled as function that receives A and returns it value serialized to byte array together with content type.

    Definition Classes
    Responses → Responses
  5. type ResponseHeaders[A] = (A) => List[(String, String)]

    Information carried by responses’ headers.

    Information carried by responses’ headers.

    You can construct values of type ResponseHeaders by using the operations responseHeader, optResponseHeader, or emptyResponseHeaders.

    Definition Classes
    Responses → Responses
    Note

    This type has implicit methods provided by the SemigroupalSyntax and PartialInvariantFunctorSyntax classes.

  6. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  7. abstract type ServerError
    Definition Classes
    Errors
  8. type StatusCode = Status
    Definition Classes
    StatusCodes → StatusCodes

Abstract Value Members

  1. abstract def clientErrorsResponseEntity: ResponseEntity[ClientErrors]
    Definition Classes
    Errors
  2. abstract def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
    Definition Classes
    Errors
  3. abstract def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    Errors
  4. abstract def serverErrorResponseEntity: ResponseEntity[ServerError]
    Definition Classes
    Errors
  5. abstract def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    Errors
  6. abstract def throwableToServerError(throwable: Throwable): ServerError
    Definition Classes
    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. def Accepted: uzhttp.Status.Accepted
    Definition Classes
    StatusCodes → StatusCodes
  5. def BadRequest: Status
    Definition Classes
    StatusCodes → StatusCodes
  6. def Created: uzhttp.Status.Created
    Definition Classes
    StatusCodes → StatusCodes
  7. def Forbidden: Status
    Definition Classes
    StatusCodes → StatusCodes
  8. def InternalServerError: Status
    Definition Classes
    StatusCodes → StatusCodes
  9. def NoContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  10. def NotFound: Status
    Definition Classes
    StatusCodes → StatusCodes
  11. def NotImplemented: Status
    Definition Classes
    StatusCodes → StatusCodes
  12. def OK: Ok
    Definition Classes
    StatusCodes → StatusCodes
  13. def Unauthorized: Status
    Definition Classes
    StatusCodes → StatusCodes
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  16. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    Responses → Responses
  17. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  19. def emptyResponse: ResponseEntity[Unit]
    Definition Classes
    Responses → Responses
  20. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    Responses → Responses
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  23. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def ok[A, B, R](entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    Responses
  32. def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]

    Response headers optionally containing a header with the given name.

    Response headers optionally containing a header with the given name. Client interpreters should model the header value as Some[String], or None if the response header is missing. Server interpreters should produce such a response header. Documentation interpreters should document this header.

    Definition Classes
    Responses → Responses
  33. def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]

    Server interpreters construct a response with the given status and entity.

    Server interpreters construct a response with the given status and entity. Client interpreters accept a response only if it has a corresponding status code.

    statusCode

    Response status code

    entity

    Response entity

    docs

    Response documentation

    headers

    Response headers

    Definition Classes
    Responses → Responses
  34. implicit lazy val responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    Responses → Responses
  35. def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]

    Response headers containing a header with the given name.

    Response headers containing a header with the given name. Client interpreters should model the header value as String, or fail if the response header is missing. Server interpreters should produce such a response header. Documentation interpreters should document this header.

    Example:

    val versionedResource: Endpoint[Unit, (SomeResource, String)] =
  endpoint(
    get(path / "versioned-resource"),
    ok(
      jsonResponse[SomeResource],
      headers = responseHeader("ETag")
    )
  )
    Definition Classes
    Responses → Responses
  36. implicit lazy val responseHeadersInvariantFunctor: PartialInvariantFunctor[ResponseHeaders]
    Definition Classes
    Responses → Responses
  37. implicit lazy val responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    Responses → Responses
  38. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    Responses → Responses
  39. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. def textResponse: ResponseEntity[String]
    Definition Classes
    Responses → Responses
  42. def toString(): String
    Definition Classes
    AnyRef → Any
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  46. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses

Inherited from StatusCodes

Inherited from Errors

Inherited from algebra.Responses

Inherited from endpoints.InvariantFunctorSyntax

Inherited from algebra.StatusCodes

Inherited from AnyRef

Inherited from Any

operations

types

Ungrouped