Packages

t

endpoints4s.pekkohttp.server

ChunkedJsonEntities

trait ChunkedJsonEntities extends algebra.ChunkedJsonEntities with ChunkedEntities with JsonEntitiesFromCodecs

Interpreter for the algebra.ChunkedJsonEntities algebra in the endpoints4s.pekkohttp.server family.

Source
ChunkedEntities.scala
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ChunkedJsonEntities
  2. JsonEntitiesFromCodecs
  3. JsonEntitiesFromCodecs
  4. ChunkedEntities
  5. EndpointsWithCustomErrors
  6. Methods
  7. Urls
  8. StatusCodes
  9. ChunkedJsonEntities
  10. ChunkedJsonResponseEntities
  11. ChunkedJsonRequestEntities
  12. Framing
  13. JsonCodecs
  14. JsonEntities
  15. ChunkedEntities
  16. ChunkedResponseEntities
  17. ChunkedRequestEntities
  18. Chunks
  19. EndpointsWithCustomErrors
  20. Errors
  21. Responses
  22. StatusCodes
  23. Requests
  24. SemigroupalSyntax
  25. Methods
  26. Urls
  27. PartialInvariantFunctorSyntax
  28. InvariantFunctorSyntax
  29. AnyRef
  30. 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. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

    Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

    Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

    Definition Classes
    InvariantFunctorSyntax
  2. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
  3. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  4. final class CallbackDocs extends Serializable

    Definition Classes
    EndpointsWithCustomErrors
  5. final class EndpointDocs extends Serializable

    Definition Classes
    EndpointsWithCustomErrors
  6. implicit final class EndpointSyntax[A, B] extends AnyRef

    Extension methods for Endpoint.

    Extension methods for Endpoint.

    Definition Classes
    EndpointsWithCustomErrors
  7. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  8. implicit final class RequestSyntax[A] extends AnyRef

    Extension methods for Request.

    Extension methods for Request.

    Definition Classes
    Requests
  9. implicit class ResponseSyntax[A] extends AnyRef

    Extension methods for Response.

    Extension methods for Response.

    Definition Classes
    Responses
  10. implicit class PathOps[A] extends AnyRef

    Convenient methods for Paths.

    Convenient methods for Paths.

    Definition Classes
    Urls
  11. implicit class QueryStringSyntax[A] extends AnyRef

    Extension methods on QueryString.

    Extension methods on QueryString.

    Definition Classes
    Urls
  12. type CallbacksDocs = Map[String, CallbackDocs]

    Callbacks indexed by URL pattern

    Callbacks indexed by URL pattern

    Definition Classes
    EndpointsWithCustomErrors
    See also

    Swagger Documentation at https://swagger.io/docs/specification/callbacks/

  13. type Chunks[A] = Source[A, _]

    A stream of chunks of type A.

    A stream of chunks of type A.

    Definition Classes
    ChunkedEntitiesChunks
  14. abstract type ClientErrors

    Errors in a request built by a client

    Errors in a request built by a client

    Definition Classes
    Errors
  15. class Framing extends AnyRef
  16. abstract type JsonCodec[A]

    A JSON codec type class

    A JSON codec type class

    Definition Classes
    JsonCodecs
  17. type JsonRequest[A] = JsonCodec[A]

    Type class defining how to represent the A information as a JSON request entity

    Type class defining how to represent the A information as a JSON request entity

    Definition Classes
    JsonCodecsJsonEntities
  18. type JsonResponse[A] = JsonCodec[A]

    Type class defining how to represent the A information as a JSON response entity

    Type class defining how to represent the A information as a JSON response entity

    Definition Classes
    JsonCodecsJsonEntities
  19. type Method = HttpMethod

    HTTP Method

    HTTP Method

    Definition Classes
    MethodsMethods
  20. type RequestEntity[A] = Directive[(A)]

    Information carried by request entity

    Information carried by request entity

    Values of type RequestEntity[A] can be constructed by using the operations emptyRequest or textRequest. Additional types of request entities are provided by other algebra modules, such as JsonEntities or ChunkedEntities.

    • Server interpreters raise an error if they can’t parse the incoming request entity as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
    Definition Classes
    EndpointsWithCustomErrorsRequests
    Note

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

  21. type Response[A] = (A) => Route

    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

    Values of type Response[A] can be constructed by using the operations ok, badRequest, internalServerError, or the more general operation response.

    Definition Classes
    EndpointsWithCustomErrorsResponses
    Note

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

  22. type ResponseEntity[A] = Marshaller[A, MessageEntity]

    An HTTP response entity carrying an information of type A

    An HTTP response entity carrying an information of type A

    Values of type ResponseEntity can be constructed by using the operations emptyResponse or textResponse. Additional types of response entities are provided by other algebra modules, such as JsonEntities or ChunkedEntities.

    Definition Classes
    EndpointsWithCustomErrorsResponses
    Note

    This type has implicit methods provided by the InvariantFunctorSyntax class

  23. type ResponseHeaders[A] = (A) => Seq[HttpHeader]

    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
    EndpointsWithCustomErrorsResponses
    Note

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

  24. abstract type ServerError

    Error raised by the business logic of a server

    Error raised by the business logic of a server

    Definition Classes
    Errors
  25. type StatusCode = org.apache.pekko.http.scaladsl.model.StatusCode

    HTTP Status Code

    HTTP Status Code

    Definition Classes
    StatusCodesStatusCodes
  26. type WithDefault[A] = A

    This type is necessary to express different perspectives of servers and clients on optional query string parameters with default value:

    This type is necessary to express different perspectives of servers and clients on optional query string parameters with default value:

    • Client interpreters should define it as Option[A] and omit query string parameters with default value that are empty
    • Server interpreters should define it as A and accept incoming requests whose query string parameters with default value are missing, while providing the defined default value
    • Documentation interpreters should mark the parameter as optional and document the provided default value
    Definition Classes
    UrlsUrls
  27. case class Endpoint[A, B](request: Request[A], response: Response[B]) extends Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  28. trait Request[A] extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors
  29. trait RequestHeaders[A] extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors
  30. trait Path[A] extends EndpointsWithCustomErrors.Url[A]
    Definition Classes
    Urls
  31. trait QueryString[T] extends AnyRef
    Definition Classes
    Urls
  32. trait QueryStringParam[T] extends AnyRef

    Given a parameter name and a query string content, returns a decoded parameter value of type T, or Invalid if decoding failed

    Given a parameter name and a query string content, returns a decoded parameter value of type T, or Invalid if decoding failed

    Definition Classes
    Urls
  33. trait Segment[A] extends AnyRef
    Definition Classes
    Urls
  34. trait Url[A] extends AnyRef
    Definition Classes
    Urls

Abstract Value Members

  1. abstract def clientErrorsResponseEntity: ResponseEntity[ClientErrors]

    Format of the response entity carrying the client errors.

    Format of the response entity carrying the client errors.

    Definition Classes
    Errors
  2. abstract def clientErrorsToInvalid(clientErrors: 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
    Errors
  3. abstract def invalidToClientErrors(invalid: Invalid): 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
    Errors
  4. abstract def serverErrorResponseEntity: ResponseEntity[ServerError]

    Format of the response entity carrying the server error.

    Format of the response entity carrying the server error.

    Definition Classes
    Errors
  5. abstract def serverErrorToThrowable(serverError: 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
    Errors
  6. abstract def stringCodec[A](implicit arg0: JsonCodec[A]): Codec[String, A]

    Turns a JsonCodec[A] into a Codec[String, A]

    Turns a JsonCodec[A] into a Codec[String, A]

    Definition Classes
    JsonEntitiesFromCodecs
  7. abstract def throwableToServerError(throwable: Throwable): 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
    Errors

Concrete Value Members

  1. object CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  2. object EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  3. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def ##: Int
    Definition Classes
    AnyRef → Any
  5. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ChunkedJsonEntities toany2stringadd[ChunkedJsonEntities] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  6. def ->[B](y: B): (ChunkedJsonEntities, B)
    Implicit
    This member is added by an implicit conversion from ChunkedJsonEntities toArrowAssoc[ChunkedJsonEntities] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  7. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def Accepted: Success

    Definition Classes
    StatusCodesStatusCodes
  9. def AlreadyReported: Success

    Definition Classes
    StatusCodesStatusCodes
  10. def BadRequest: ClientError

    Definition Classes
    StatusCodesStatusCodes
    Note

    You should use the badRequest constructor provided by the endpoints4s.algebra.Responses trait to ensure that errors produced by endpoints4s are consistently handled by interpreters.

  11. def Conflict: ClientError

    Definition Classes
    StatusCodesStatusCodes
  12. def Created: Success

    Definition Classes
    StatusCodesStatusCodes
  13. def Delete: HttpMethod

    Definition Classes
    MethodsMethods
  14. def ExpectationFailed: ClientError

    Definition Classes
    StatusCodesStatusCodes
  15. def FailedDependency: ClientError

    Definition Classes
    StatusCodesStatusCodes
  16. def Forbidden: ClientError

    Definition Classes
    StatusCodesStatusCodes
  17. def Get: HttpMethod

    Definition Classes
    MethodsMethods
  18. def Gone: ClientError

    Definition Classes
    StatusCodesStatusCodes
  19. def IMUsed: Success

    Definition Classes
    StatusCodesStatusCodes
  20. def InternalServerError: org.apache.pekko.http.scaladsl.model.StatusCodes.ServerError

    Definition Classes
    StatusCodesStatusCodes
    Note

    You should use the internalServerError constructor provided by the endpoints4s.algebra.Responses trait to ensure that errors produced by endpoints4s are consistently handled by interpreters.

  21. def LengthRequired: ClientError

    Definition Classes
    StatusCodesStatusCodes
  22. def Locked: ClientError

    Definition Classes
    StatusCodesStatusCodes
  23. def MethodNotAllowed: ClientError

    Definition Classes
    StatusCodesStatusCodes
  24. def MisdirectedRequest: ClientError

    Definition Classes
    StatusCodesStatusCodes
  25. def MultiStatus: Success

    Definition Classes
    StatusCodesStatusCodes
  26. def NoContent: Success

    Definition Classes
    StatusCodesStatusCodes
  27. def NonAuthoritativeInformation: Success

    Definition Classes
    StatusCodesStatusCodes
  28. def NotAcceptable: ClientError

    Definition Classes
    StatusCodesStatusCodes
  29. def NotFound: ClientError

    Definition Classes
    StatusCodesStatusCodes
  30. def NotImplemented: org.apache.pekko.http.scaladsl.model.StatusCodes.ServerError

    Definition Classes
    StatusCodesStatusCodes
  31. def NotModified: Redirection

    Definition Classes
    StatusCodesStatusCodes
  32. def OK: Success

    Definition Classes
    StatusCodesStatusCodes
  33. def Options: HttpMethod

    Definition Classes
    MethodsMethods
  34. def PartialContent: Success

    Definition Classes
    StatusCodesStatusCodes
  35. def Patch: HttpMethod

    Definition Classes
    MethodsMethods
  36. def PayloadTooLarge: ClientError

    Definition Classes
    StatusCodesStatusCodes
  37. def PaymentRequired: ClientError

    Definition Classes
    StatusCodesStatusCodes
  38. def PermanentRedirect: Redirection

    Definition Classes
    StatusCodesStatusCodes
  39. def Post: HttpMethod

    Definition Classes
    MethodsMethods
  40. def PreconditionFailed: ClientError

    Definition Classes
    StatusCodesStatusCodes
  41. def PreconditionRequired: ClientError

    Definition Classes
    StatusCodesStatusCodes
  42. def ProxyAuthenticationRequired: ClientError

    Definition Classes
    StatusCodesStatusCodes
  43. def Put: HttpMethod

    Definition Classes
    MethodsMethods
  44. def RangeNotSatisfiable: ClientError

    Definition Classes
    StatusCodesStatusCodes
  45. def RequestHeaderFieldsTooLarge: ClientError

    Definition Classes
    StatusCodesStatusCodes
  46. def RequestTimeout: ClientError

    Definition Classes
    StatusCodesStatusCodes
  47. def ResetContent: Success

    Definition Classes
    StatusCodesStatusCodes
  48. def TemporaryRedirect: Redirection

    Definition Classes
    StatusCodesStatusCodes
  49. def TooEarly: ClientError

    Definition Classes
    StatusCodesStatusCodes
  50. def TooManyRequests: ClientError

    Definition Classes
    StatusCodesStatusCodes
  51. def Unauthorized: ClientError

    Definition Classes
    StatusCodesStatusCodes
  52. def UnavailableForLegalReasons: ClientError

    Definition Classes
    StatusCodesStatusCodes
  53. def UnprocessableEntity: ClientError

    Definition Classes
    StatusCodesStatusCodes
  54. def UnsupportedMediaType: ClientError

    Definition Classes
    StatusCodesStatusCodes
  55. def UpgradeRequired: ClientError

    Definition Classes
    StatusCodesStatusCodes
  56. def UriTooLong: ClientError

    Definition Classes
    StatusCodesStatusCodes
  57. def addRequestHeaders[A, H](currentRequest: Request[A], heads: RequestHeaders[H])(implicit tupler: Tupler[A, H]): Request[Out]

    Add the provided headers to the request.

    Add the provided headers to the request.

    Definition Classes
    EndpointsWithCustomErrorsRequests
  58. def addRequestQueryString[A, Q](request: Request[A], qs: QueryString[Q])(implicit tupler: Tupler[A, Q]): Request[Out]

    Add the provided queryString to the request.

    Add the provided queryString to the request.

    Definition Classes
    EndpointsWithCustomErrorsRequests
  59. def addResponseHeaders[A, H](response: Response[A], headers: ResponseHeaders[H])(implicit tupler: Tupler[A, H]): Response[Out]

    Add the provided headers to the response.

    Add the provided headers to the response.

    Note that if the response describes a choice of several possible responses (resulting from the orElse operation), the headers will be added to all the possible responses.

    Definition Classes
    EndpointsWithCustomErrorsResponses
  60. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  61. final def badRequest[A, R](docs: Documentation = None, headers: ResponseHeaders[A] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]

    Bad Request (400) response, with an entity of type ClientErrors.

    Bad Request (400) response, with an entity of type ClientErrors.

    Definition Classes
    Responses
    See also

    endpoints4s.algebra.Errors and endpoints4s.algebra.BuiltInErrors

  62. implicit def booleanQueryString: QueryStringParam[Boolean]

    Query string parameter containing a Boolean value

    Query string parameter containing a Boolean value

    Definition Classes
    Urls
  63. def bytesChunksRequest: RequestEntity[Chunks[Array[Byte]]]

    A request entity carrying chunks of Array[Byte] values

    A request entity carrying chunks of Array[Byte] values

    Definition Classes
    ChunkedEntitiesChunkedRequestEntities
  64. def bytesChunksResponse: ResponseEntity[Chunks[Array[Byte]]]

    A response entity carrying chunks of Array[Byte] values

    A response entity carrying chunks of Array[Byte] values

    Definition Classes
    ChunkedEntitiesChunkedResponseEntities
  65. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

    Chains the two paths

    Chains the two paths

    Definition Classes
    UrlsUrls
  66. def choiceRequestEntity[A, B](requestEntityA: Directive1[A], requestEntityB: Directive1[B]): Directive1[Either[A, B]]

    Alternative between two possible request entities, differentiated by the Content-Type header

    Alternative between two possible request entities, differentiated by the Content-Type header

    Definition Classes
    EndpointsWithCustomErrorsRequests
    Note

    If A and B are both JSON-encoded and use disjoint schemas, use endpoints4s.algebra.JsonSchemas.TaggedOps#orElse at the schema level instead

    • Server interpreters accept either of the request entities
    • Client interpreters provide one of the two request entities
    • Documentation interpreters list all possible content types and their entities
  67. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]

    Alternative between two possible choices of responses.

    Alternative between two possible choices of responses.

    Server interpreters construct either one or the other response. Client interpreters accept either one or the other response. Documentation interpreters list all the possible responses.

    Definition Classes
    EndpointsWithCustomErrorsResponses
  68. lazy val clientErrorsResponse: Response[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
  69. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  70. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

    Concatenates two QueryStrings

    Concatenates two QueryStrings

    Definition Classes
    UrlsUrls
  71. def convToDirective1(directive: Directive0): Directive1[Unit]
    Attributes
    protected
    Definition Classes
    Urls
  72. final def delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

    Helper method to perform DELETE request

    Helper method to perform DELETE request

    UrlP

    Payload carried by url

    HeadersP

    Payload carried by headers

    Definition Classes
    Requests
  73. lazy val directive1InvFunctor: PartialInvariantFunctor[Directive1]
    Definition Classes
    EndpointsWithCustomErrors
  74. implicit def doubleQueryString: QueryStringParam[Double]

    Codec for query string parameters of type Double

    Codec for query string parameters of type Double

    Definition Classes
    Urls
  75. implicit def doubleSegment: Segment[Double]

    Path segment codec for type Double

    Path segment codec for type Double

    Definition Classes
    Urls
  76. def emptyRequest: RequestEntity[Unit]

    Empty request -- request without a body.

    Empty request -- request without a body. Use description of endpoints4s.algebra.Endpoints#endpoint to document an empty body.

    Definition Classes
    EndpointsWithCustomErrorsRequests
  77. def emptyRequestHeaders: RequestHeaders[Unit]

    Ignore headers

    Ignore headers

    • Server interpreters don’t try to parse any information from the request headers,
    • Client interpreters supply no specific headers

    Use description of endpoints4s.algebra.Endpoints#endpoint to document empty headers.

    Definition Classes
    EndpointsWithCustomErrorsRequests
  78. def emptyResponse: ResponseEntity[Unit]

    Empty response entity

    Empty response entity

    • Server interpreters produce no response entity,
    • Client interpreters ignore the response entity.
    Definition Classes
    EndpointsWithCustomErrorsResponses
  79. def emptyResponseHeaders: ResponseHeaders[Unit]

    No particular response header.

    No particular response header.

    • Client interpreters should ignore information carried by response headers.
    Definition Classes
    EndpointsWithCustomErrorsResponses
  80. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]

    Define an HTTP endpoint

    Define an HTTP endpoint

    request

    Request

    response

    Response

    docs

    Documentation (used by documentation interpreters)

    Definition Classes
    EndpointsWithCustomErrorsEndpointsWithCustomErrors
  81. def ensuring(cond: (ChunkedJsonEntities) => Boolean, msg: => Any): ChunkedJsonEntities
    Implicit
    This member is added by an implicit conversion from ChunkedJsonEntities toEnsuring[ChunkedJsonEntities] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  82. def ensuring(cond: (ChunkedJsonEntities) => Boolean): ChunkedJsonEntities
    Implicit
    This member is added by an implicit conversion from ChunkedJsonEntities toEnsuring[ChunkedJsonEntities] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  83. def ensuring(cond: Boolean, msg: => Any): ChunkedJsonEntities
    Implicit
    This member is added by an implicit conversion from ChunkedJsonEntities toEnsuring[ChunkedJsonEntities] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  84. def ensuring(cond: Boolean): ChunkedJsonEntities
    Implicit
    This member is added by an implicit conversion from ChunkedJsonEntities toEnsuring[ChunkedJsonEntities] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  85. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  86. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  87. final def get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

    Helper method to perform GET request

    Helper method to perform GET request

    UrlP

    Payload carried by url

    HeadersP

    Payload carried by headers

    Definition Classes
    Requests
  88. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  89. def handleClientErrors(invalid: Invalid): StandardRoute

    This method is called by endpoints4s when decoding a request failed.

    This method is called by endpoints4s when decoding a request failed.

    The provided implementation calls clientErrorsResponse to complete with a response containing the errors.

    This method can be overridden to customize the error reporting logic.

    Definition Classes
    Urls
  90. def handleServerError(throwable: Throwable): StandardRoute

    This method is called by endpoints when an exception is thrown during request processing.

    This method is called by endpoints when an exception is thrown during request processing.

    The provided implementation uses serverErrorResponse to complete with a response containing the error message.

    This method can be overridden to customize the error reporting logic.

    Definition Classes
    EndpointsWithCustomErrors
  91. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  92. implicit def intQueryString: QueryStringParam[Int]

    Ability to define Int query string parameters

    Ability to define Int query string parameters

    Definition Classes
    Urls
  93. implicit def intSegment: Segment[Int]

    Path segment codec for type Int

    Path segment codec for type Int

    Definition Classes
    Urls
  94. final def internalServerError[A, R](docs: Documentation = None, headers: ResponseHeaders[A] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]

    Internal Server Error (500) response, with an entity of type ServerError.

    Internal Server Error (500) response, with an entity of type ServerError.

    Definition Classes
    Responses
    See also

    endpoints4s.algebra.Errors and endpoints4s.algebra.BuiltInErrors

  95. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  96. def joinDirectives[T1, T2](dir1: Directive1[T1], dir2: Directive1[T2])(implicit tupler: Tupler[T1, T2]): Directive1[Out]

    Simpler alternative to Directive.&() method

    Simpler alternative to Directive.&() method

    Attributes
    protected
    Definition Classes
    Urls
  97. def jsonChunksRequest[A](framing: Framing)(implicit codec: JsonCodec[A]): RequestEntity[Chunks[A]]

    A request entity carrying chunks of JSON values

    A request entity carrying chunks of JSON values

    A

    Type of values serialized into JSON

    framing

    Framing applied to chunks

    Definition Classes
    ChunkedJsonEntitiesChunkedJsonRequestEntities
  98. def jsonChunksRequest[A](implicit codec: JsonCodec[A]): RequestEntity[Chunks[A]]
  99. def jsonChunksResponse[A](framing: Framing)(implicit codec: JsonCodec[A]): ResponseEntity[Chunks[A]]

    A response entity carrying chunks of JSON values

    A response entity carrying chunks of JSON values

    A

    Type of values serialized into JSON

    framing

    Framing applied to chunks

    Definition Classes
    ChunkedJsonEntitiesChunkedJsonResponseEntities
  100. def jsonChunksResponse[A](implicit codec: JsonCodec[A]): ResponseEntity[Chunks[A]]
  101. def jsonRequest[A](implicit codec: JsonCodec[A]): RequestEntity[A]

    Request with a JSON body, given an implicit JsonRequest[A]

    Request with a JSON body, given an implicit JsonRequest[A]

    • Server interpreters accept requests with content-type application/json and reject requests with an incorrect content-type.
    • Client interpreters supply content-type application/json
    Definition Classes
    JsonEntitiesFromCodecsJsonEntities
  102. def jsonResponse[A](implicit codec: JsonCodec[A]): ResponseEntity[A]

    Defines a Response[A] given an implicit JsonResponse[A]

    Defines a Response[A] given an implicit JsonResponse[A]

    Definition Classes
    JsonEntitiesFromCodecsJsonEntities
  103. implicit def longQueryString: QueryStringParam[Long]

    Query string parameter containing a Long value

    Query string parameter containing a Long value

    Definition Classes
    Urls
  104. implicit def longSegment: Segment[Long]

    Path segment codec for type Long

    Path segment codec for type Long

    Definition Classes
    Urls
  105. def mapEndpointDocs[A, B](endpoint: Endpoint[A, B], f: (EndpointDocs) => EndpointDocs): Endpoint[A, B]

    Map the inner documentation of the endpoint to new documentation.

    Map the inner documentation of the endpoint to new documentation.

    endpoint

    The current endpoint that is being mapped.

    returns

    The endpoint with the mapped documentation.

    Definition Classes
    EndpointsWithCustomErrorsEndpointsWithCustomErrors
  106. def mapEndpointRequest[A, B, C](endpoint: Endpoint[A, B], f: (Request[A]) => Request[C]): Endpoint[C, B]

    Map the inner request of the endpoint to a new request.

    Map the inner request of the endpoint to a new request. This is for example useful to add Auth headers to an existing endpoint.

    endpoint

    The current endpoint that is being mapped.

    returns

    The endpoint with the mapped request.

    Definition Classes
    EndpointsWithCustomErrorsEndpointsWithCustomErrors
    Example:
    1. val myEndpoint: Endpoint[Input, Output] = ???
      val basicAuthHeaders: RequestHeaders[Credentials] = ???
      
      val endpointWithAuth: Endpoint[(Input, Credentials), Output] =
        myEndpoint.mapRequest(_.addHeaders(basicAuthHeader))
  107. def mapEndpointResponse[A, B, C](endpoint: Endpoint[A, B], f: (Response[B]) => Response[C]): Endpoint[A, C]

    Map the inner response of the endpoint to a new response.

    Map the inner response of the endpoint to a new response. This is for example useful so you can add error handling to an existing endpoint.

    endpoint

    The current endpoint that is being mapped.

    returns

    The endpoint with the mapped response.

    Definition Classes
    EndpointsWithCustomErrorsEndpointsWithCustomErrors
    Example:
    1. val myEndpoint: Endpoint[Input, Output] = ???
      val errorResponse: Response[Error] = ???
      
      val endpointWithErrorHandling: Endpoint[Input, Either[Error, Output]] =
        myEndpoint.mapResponse(resp => resp orElse errorResponse)
  108. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  109. lazy val newLineDelimiterFraming: Framing

    Frames are delimited by a new-line separator

    Frames are delimited by a new-line separator

    Definition Classes
    ChunkedJsonEntitiesFraming
  110. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  111. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  112. final def ok[A, B, R](entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[A, B, R]): Response[R]

    OK (200) Response with the given entity

    OK (200) Response with the given entity

    Definition Classes
    Responses
  113. def optQsWithDefault[A](name: String, default: A, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[WithDefault[A]]

    Builds a QueryString with one optional parameter, which has a default value.

    Builds a QueryString with one optional parameter, which has a default value.

    Examples:

    optQsWithDefault[Int]("page", 1) // optional `page` parameter, with default value 1
    A

    Type of the value carried by the parameter

    name

    Parameter’s name

    Definition Classes
    UrlsUrls
  114. def optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]

    An optional request header

    An optional request header

    name

    Header name (e.g., “Authorization”)

    Definition Classes
    EndpointsWithCustomErrorsRequests
  115. 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
    EndpointsWithCustomErrorsResponses
  116. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]

    Make a query string parameter optional:

    Make a query string parameter optional:

    path / "articles" /? qs[Option[Int]]("page")
    • Client interpreters must omit optional query string parameters that are empty.
    • Server interpreters must accept incoming requests whose optional query string parameters are missing, and they must report a failure for incoming requests whose optional query string parameters are present, but malformed,
    • Documentation interpreters should mark the parameter as optional.
    Definition Classes
    UrlsUrls
  117. final def patch[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

    Helper method to perform PATCH request

    Helper method to perform PATCH request

    UrlP

    Payload carried by url

    BodyP

    Payload carried by body

    HeadersP

    Payload carried by headers

    UrlAndBodyPTupled

    Payloads of Url and Body tupled together by Tupler

    docs

    Request documentation

    Definition Classes
    Requests
  118. val path: Path[Unit]

    An empty path.

    An empty path.

    Useful to begin a path definition:

    path / "foo" / segment[Int] /? qs[String]("bar")
    Definition Classes
    Urls
  119. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  120. final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

    Helper method to perform POST request

    Helper method to perform POST request

    UrlP

    Payload carried by url

    BodyP

    Payload carried by body

    HeadersP

    Payload carried by headers

    UrlAndBodyPTupled

    Payloads of Url and Body tupled together by Tupler

    docs

    Request documentation

    Definition Classes
    Requests
  121. final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

    Helper method to perform PUT request

    Helper method to perform PUT request

    UrlP

    Payload carried by url

    BodyP

    Payload carried by body

    HeadersP

    Payload carried by headers

    UrlAndBodyPTupled

    Payloads of Url and Body tupled together by Tupler

    Definition Classes
    Requests
  122. def qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]

    Builds a QueryString with one parameter.

    Builds a QueryString with one parameter.

    Examples:

    qs[Int]("page")            // mandatory `page` parameter
    qs[Option[String]]("lang") // optional `lang` parameter
    qs[List[Long]]("id")       // repeated `id` parameter
    A

    Type of the value carried by the parameter

    name

    Parameter’s name

    Definition Classes
    UrlsUrls
  123. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  124. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  125. def remainingSegments(name: String, docs: Documentation): Path[String]

    The remaining segments of the path.

    The remaining segments of the path. The String value carried by this Path is still URL-encoded.

    Definition Classes
    UrlsUrls
  126. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]

    Support query string parameters with multiple values:

    Support query string parameters with multiple values:

    path / "articles" /? qs[List[Long]]("id")
    • Server interpreters must accept incoming requests where such parameters are missing (in such a case, its value is an empty collection), and report a failure if at least one value is malformed.
    Definition Classes
    UrlsUrls
  127. def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B] = emptyRequest, docs: Documentation = None, headers: RequestHeaders[C] = emptyRequestHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]

    Request for given parameters

    Request for given parameters

    method

    Request method

    url

    Request URL

    entity

    Request entity

    docs

    Request documentation

    headers

    Request headers

    Definition Classes
    EndpointsWithCustomErrorsRequests
  128. implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    PartialInvariantFunctorSyntax

  129. def requestHeader(name: String, docs: Documentation): RequestHeaders[String]

    A required request header

    A required request header

    name

    Header name (e.g., “Authorization”)

    Definition Classes
    EndpointsWithCustomErrorsRequests
  130. implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    PartialInvariantFunctorSyntax

  131. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]

    Provides ++ operation.

    Provides ++ operation.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    SemigroupalSyntax

  132. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    PartialInvariantFunctorSyntax

  133. def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[A, B, R]): Response[R]

    Define an HTTP response

    Define an HTTP response

    • 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
    EndpointsWithCustomErrorsResponses
  134. implicit lazy val responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrorsResponses
  135. 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
    EndpointsWithCustomErrorsResponses
  136. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]

    Provides xmap operation.

    Provides xmap operation.

    Definition Classes
    EndpointsWithCustomErrorsResponses
    See also

    InvariantFunctorSyntax

  137. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]

    Provides ++ operation.

    Provides ++ operation.

    Definition Classes
    EndpointsWithCustomErrorsResponses
    See also

    SemigroupalSyntax

  138. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]

    Provides the operation xmap to the type Response

    Provides the operation xmap to the type Response

    Definition Classes
    EndpointsWithCustomErrorsResponses
    See also

    InvariantFunctorSyntax

  139. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]

    A path segment carrying an A information

    A path segment carrying an A information

    Definition Classes
    UrlsUrls
  140. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  141. lazy val serverErrorResponse: Response[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
  142. def staticPathSegment(segment: String): Path[Unit]

    A path segment whose value is the given segment

    A path segment whose value is the given segment

    Definition Classes
    UrlsUrls
  143. implicit lazy val stringQueryString: QueryStringParam[String]

    Ability to define String query string parameters

    Ability to define String query string parameters

    Definition Classes
    UrlsUrls
  144. implicit def stringSegment: Segment[String]

    Path segment codec for type String

    Path segment codec for type String

    • Server interpreters should return an URL-decoded string value,
    • Client interpreters should take an URL-decoded string value.
    Definition Classes
    UrlsUrls
  145. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  146. def textChunksRequest: RequestEntity[Chunks[String]]

    A request entity carrying chunks of String values

    A request entity carrying chunks of String values

    Definition Classes
    ChunkedEntitiesChunkedRequestEntities
  147. def textChunksResponse: ResponseEntity[Chunks[String]]

    A response entity carrying chunks of String values

    A response entity carrying chunks of String values

    Definition Classes
    ChunkedEntitiesChunkedResponseEntities
  148. def textRequest: RequestEntity[String]

    Request with a String body.

    Request with a String body.

    • Server interpreters accept requests with content-type text/plain and reject requests with an incorrect content-type.
    • Server interpreters will use the character encoding set in the content-type header to determine how the text is decoded.
    • Client interpreters supply content-type text/plain with an explicit character encoding
    Definition Classes
    EndpointsWithCustomErrorsRequests
  149. def textResponse: ResponseEntity[String]

    Text response entity

    Text response entity

    • Server interpreters produce an HTTP response with a text/plain content type.
    Definition Classes
    EndpointsWithCustomErrorsResponses
  150. def toString(): String
    Definition Classes
    AnyRef → Any
  151. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]

    Provides xmap and xmapPartial operations

    Provides xmap and xmapPartial operations

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  152. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

    Builds an URL from the given path and query string

    Builds an URL from the given path and query string

    Definition Classes
    UrlsUrls
  153. implicit def uuidQueryString: QueryStringParam[UUID]

    Ability to define UUID query string parameters

    Ability to define UUID query string parameters

    Definition Classes
    Urls
  154. implicit def uuidSegment: Segment[UUID]

    Path segment codec for type UUID

    Path segment codec for type UUID

    Definition Classes
    Urls
  155. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  156. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  157. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  158. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation = None): Response[Option[A]]

    Turns a Response[A] into a Response[Option[A]].

    Turns a Response[A] into a Response[Option[A]].

    Interpreters represent None with an empty HTTP response whose status code is 404 (Not Found).

    Definition Classes
    Responses

Deprecated Value Members

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

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ChunkedJsonEntities toStringFormat[ChunkedJsonEntities] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

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

Inherited from ChunkedEntities

Inherited from Methods

Inherited from Urls

Inherited from StatusCodes

Inherited from algebra.Framing

Inherited from JsonCodecs

Inherited from algebra.JsonEntities

Inherited from ChunkedRequestEntities

Inherited from algebra.Chunks

Inherited from Errors

Inherited from Responses

Inherited from algebra.StatusCodes

Inherited from Requests

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromChunkedJsonEntities to any2stringadd[ChunkedJsonEntities]

Inherited by implicit conversion StringFormat fromChunkedJsonEntities to StringFormat[ChunkedJsonEntities]

Inherited by implicit conversion Ensuring fromChunkedJsonEntities to Ensuring[ChunkedJsonEntities]

Inherited by implicit conversion ArrowAssoc fromChunkedJsonEntities to ArrowAssoc[ChunkedJsonEntities]

Types

Types introduced by the algebra

Operations

Operations creating and transforming values

Ungrouped