Packages

t

endpoints4s.play.server

ChunkedJsonEntities

trait ChunkedJsonEntities extends ChunkedEntities with algebra.ChunkedJsonEntities with JsonEntitiesFromCodecs

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

Linear Supertypes
JsonEntitiesFromCodecs, algebra.JsonEntitiesFromCodecs, algebra.ChunkedJsonEntities, ChunkedJsonResponseEntities, ChunkedJsonRequestEntities, algebra.Framing, JsonCodecs, JsonEntities, ChunkedEntities, algebra.ChunkedEntities, ChunkedResponseEntities, ChunkedRequestEntities, algebra.Chunks, EndpointsWithCustomErrors, StatusCodes, Methods, Urls, algebra.EndpointsWithCustomErrors, Errors, Responses, algebra.StatusCodes, Requests, endpoints4s.SemigroupalSyntax, algebra.Methods, algebra.Urls, endpoints4s.PartialInvariantFunctorSyntax, endpoints4s.InvariantFunctorSyntax, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ChunkedJsonEntities
  2. JsonEntitiesFromCodecs
  3. JsonEntitiesFromCodecs
  4. ChunkedJsonEntities
  5. ChunkedJsonResponseEntities
  6. ChunkedJsonRequestEntities
  7. Framing
  8. JsonCodecs
  9. JsonEntities
  10. ChunkedEntities
  11. ChunkedEntities
  12. ChunkedResponseEntities
  13. ChunkedRequestEntities
  14. Chunks
  15. EndpointsWithCustomErrors
  16. StatusCodes
  17. Methods
  18. Urls
  19. EndpointsWithCustomErrors
  20. Errors
  21. Responses
  22. StatusCodes
  23. Requests
  24. SemigroupalSyntax
  25. Methods
  26. Urls
  27. PartialInvariantFunctorSyntax
  28. InvariantFunctorSyntax
  29. AnyRef
  30. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final class CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  2. type CallbacksDocs = Map[String, CallbackDocs]
    Definition Classes
    EndpointsWithCustomErrors
  3. type Chunks[A] = Source[A, _]
    Definition Classes
    ChunkedEntities → Chunks
  4. abstract type ClientErrors
    Definition Classes
    Errors
  5. final class EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  6. implicit final class EndpointSyntax[A, B] extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors
  7. class Framing extends AnyRef
  8. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  9. abstract type JsonCodec[A]
    Definition Classes
    JsonCodecs
  10. type JsonRequest[A] = JsonCodec[A]
    Definition Classes
    JsonCodecs → JsonEntities
  11. type JsonResponse[A] = JsonCodec[A]
    Definition Classes
    JsonCodecs → JsonEntities
  12. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  13. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  14. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  15. type RequestEntity[A] = (RequestHeader) ⇒ Option[BodyParser[A]]

    Decodes a request entity

    Decodes a request entity

    Definition Classes
    EndpointsWithCustomErrors → Requests
  16. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  17. type RequestExtractor[A] = (RequestHeader) ⇒ Option[A]

    Convenient type alias modeling the extraction of an A information from request headers.

    Convenient type alias modeling the extraction of an A information from request headers.

    This type has an instance of Applicative.

    Definition Classes
    Urls
  18. type RequestHeaders[A] = (Headers) ⇒ Validated[A]

    An attempt to extract an A from a request headers.

    An attempt to extract an A from a request headers.

    Models failure by returning a Left(result). That makes it possible to early return an HTTP response if a header is wrong (e.g. if an authentication information is missing)

    Definition Classes
    EndpointsWithCustomErrors → Requests
  19. implicit final class RequestSyntax[A] extends AnyRef
    Definition Classes
    Requests
  20. type Response[A] = (A) ⇒ Result

    Turns the A information into a proper Play Result

    Turns the A information into a proper Play Result

    Definition Classes
    EndpointsWithCustomErrors → Responses
  21. type ResponseEntity[A] = (A) ⇒ HttpEntity
    Definition Classes
    EndpointsWithCustomErrors → Responses
  22. type ResponseHeaders[A] = (A) ⇒ Seq[(String, String)]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  23. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  24. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  25. abstract type ServerError
    Definition Classes
    Errors
  26. type StatusCode = play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  27. type WithDefault[A] = A
    Definition Classes
    Urls → Urls
  28. case class Endpoint[A, B](request: Request[A], response: Response[B]) extends Product with Serializable

    Concrete representation of an Endpoint for routing purpose.

    Concrete representation of an Endpoint for routing purpose.

    Definition Classes
    EndpointsWithCustomErrors
  29. case class EndpointWithHandler[A, B](endpoint: Endpoint[A, B], service: (A) ⇒ Future[B]) extends ToPlayHandler with Product with Serializable

    An endpoint from which we can get a Play request handler.

    An endpoint from which we can get a Play request handler.

    Definition Classes
    EndpointsWithCustomErrors
  30. trait Request[A] extends AnyRef

    An HTTP request.

    An HTTP request.

    Has an instance of InvariantFunctor.

    Definition Classes
    EndpointsWithCustomErrors
  31. trait ToPlayHandler extends AnyRef

    Something that can be used as a Play request handler

    Something that can be used as a Play request handler

    Definition Classes
    EndpointsWithCustomErrors
  32. case class Method(value: String) extends Product with Serializable
    Definition Classes
    Methods
  33. implicit final class ApplicativeMapSyntax[F[_], A] extends AnyRef
    Definition Classes
    Urls
  34. trait Path[A] extends EndpointsWithCustomErrors.Url[A]
    Definition Classes
    Urls
  35. trait QueryString[A] extends AnyRef

    Query string encoding and decoding

    Query string encoding and decoding

    Definition Classes
    Urls
  36. trait QueryStringParam[A] extends AnyRef
    Definition Classes
    Urls
  37. trait Segment[A] extends AnyRef

    Defines how to decode and encode path segments

    Defines how to decode and encode path segments

    Definition Classes
    Urls
  38. trait Url[A] extends AnyRef
    Definition Classes
    Urls

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 val playComponents: PlayComponents
    Definition Classes
    EndpointsWithCustomErrors
  5. abstract def serverErrorResponseEntity: ResponseEntity[ServerError]
    Definition Classes
    Errors
  6. abstract def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    Errors
  7. abstract def stringCodec[A](implicit arg0: JsonCodec[A]): Codec[String, A]
    Definition Classes
    JsonEntitiesFromCodecs
  8. 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: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  5. def AlreadyReported: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  6. def BadRequest: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  7. def Conflict: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  8. def Created: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  9. def Delete: Method
    Definition Classes
    Methods → Methods
  10. implicit def EmptyEndpointToPlayHandler[A, B](endpoint: Endpoint[A, B])(implicit ev: =:=[Unit, B]): ToPlayHandler
    Definition Classes
    EndpointsWithCustomErrors
  11. def ExpectationFailed: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  12. def FailedDependency: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  13. def Forbidden: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  14. def Get: Method
    Definition Classes
    Methods → Methods
  15. def Gone: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  16. def IMUsed: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  17. def InternalServerError: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  18. def LengthRequired: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  19. def Locked: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  20. def MethodNotAllowed: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  21. def MisdirectedRequest: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  22. def MultiStatus: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  23. def NoContent: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  24. def NonAuthoritativeInformation: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  25. def NotAcceptable: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  26. def NotFound: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  27. def NotImplemented: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  28. def NotModified: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  29. def OK: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  30. def Options: Method
    Definition Classes
    Methods → Methods
  31. def PartialContent: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  32. def Patch: Method
    Definition Classes
    Methods → Methods
  33. def PayloadTooLarge: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  34. def PaymentRequired: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  35. def Post: Method
    Definition Classes
    Methods → Methods
  36. def PreconditionFailed: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  37. def PreconditionRequired: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  38. def ProxyAuthenticationRequired: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  39. def Put: Method
    Definition Classes
    Methods → Methods
  40. def RangeNotSatisfiable: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  41. def RequestHeaderFieldsTooLarge: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  42. def RequestTimeout: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  43. def ResetContent: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  44. def TooEarly: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  45. def TooManyRequests: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  46. def Unauthorized: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  47. def UnavailableForLegalReasons: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  48. def UnprocessableEntity: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  49. def UnsupportedMediaType: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  50. def UpgradeRequired: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  51. def UriTooLong: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  52. def addRequestHeaders[A, H](request: Request[A], headersP: RequestHeaders[H])(implicit tupler: Tupler[A, H]): Request[Out]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  53. def addRequestQueryString[A, Q](request: Request[A], qs: QueryString[Q])(implicit tupler: Tupler[A, Q]): Request[Out]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  54. def addResponseHeaders[A, H](response: Response[A], headers: ResponseHeaders[H])(implicit tupler: Tupler[A, H]): Response[Out]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  55. implicit lazy val applicativeRequestExtractor: Applicative[RequestExtractor]
    Definition Classes
    Urls
  56. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  57. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  58. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  59. def bytesChunksRequest: RequestEntity[Chunks[Array[Byte]]]
    Definition Classes
    ChunkedEntities → ChunkedRequestEntities
  60. def bytesChunksResponse: ResponseEntity[Chunks[Array[Byte]]]
    Definition Classes
    ChunkedEntities → ChunkedResponseEntities
  61. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  62. def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  63. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  64. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  65. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  66. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  67. final def delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  68. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  69. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  70. lazy val emptyRequest: RequestEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  71. lazy val emptyRequestHeaders: RequestHeaders[Unit]

    Always succeeds in extracting no information from the headers

    Always succeeds in extracting no information from the headers

    Definition Classes
    EndpointsWithCustomErrors → Requests
  72. def emptyResponse: ResponseEntity[Unit]

    An empty response entity

    An empty response entity

    Definition Classes
    EndpointsWithCustomErrors → Responses
  73. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  74. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  75. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  76. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  77. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  78. implicit lazy val functorRequestExtractor: Functor[RequestExtractor]
    Definition Classes
    Urls
  79. final def get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  80. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  81. def handleClientErrors(invalid: Invalid): Result

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

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

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

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

    Definition Classes
    Urls
  82. def handleServerError(throwable: Throwable): Result

    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 calls serverErrorResponse to construct a response containing the error message.

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

    Definition Classes
    EndpointsWithCustomErrors
  83. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  84. lazy val htmlResponse: ResponseEntity[Html]

    A successful HTTP response (status code 200) with an HTML entity

    A successful HTTP response (status code 200) with an HTML entity

    Definition Classes
    EndpointsWithCustomErrors
  85. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  86. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  87. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  88. implicit lazy val invariantFunctorRequest: play.api.libs.functional.InvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors
  89. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  90. def jsonChunksRequest[A](framing: Framing)(implicit codec: JsonCodec[A]): RequestEntity[Chunks[A]]
    Definition Classes
    ChunkedJsonEntities → ChunkedJsonRequestEntities
  91. def jsonChunksRequest[A](implicit codec: JsonCodec[A]): RequestEntity[Chunks[A]]
    Definition Classes
    ChunkedJsonEntities → ChunkedJsonRequestEntities
  92. def jsonChunksResponse[A](framing: Framing)(implicit codec: JsonCodec[A]): ResponseEntity[Chunks[A]]
    Definition Classes
    ChunkedJsonEntities → ChunkedJsonResponseEntities
  93. def jsonChunksResponse[A](implicit codec: JsonCodec[A]): ResponseEntity[Chunks[A]]
    Definition Classes
    ChunkedJsonEntities → ChunkedJsonResponseEntities
  94. def jsonRequest[A](implicit codec: JsonCodec[A]): RequestEntity[A]
    Definition Classes
    JsonEntitiesFromCodecs → JsonEntities
  95. def jsonResponse[A](implicit codec: JsonCodec[A]): ResponseEntity[A]
    Definition Classes
    JsonEntitiesFromCodecs → JsonEntities
  96. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  97. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  98. def mapEndpointDocs[A, B](endpoint: Endpoint[A, B], func: (EndpointDocs) ⇒ EndpointDocs): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  99. def mapEndpointRequest[A, B, C](endpoint: Endpoint[A, B], func: (Request[A]) ⇒ Request[C]): Endpoint[C, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  100. def mapEndpointResponse[A, B, C](endpoint: Endpoint[A, B], func: (Response[B]) ⇒ Response[C]): Endpoint[A, C]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  101. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  102. lazy val newLineDelimiterFraming: Framing
    Definition Classes
    ChunkedJsonEntities → Framing
  103. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  104. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  105. 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
  106. def optQsWithDefault[A](name: String, default: A, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[WithDefault[A]]
    Definition Classes
    Urls → Urls
  107. def optRequestHeader(name: String, docs: Option[String]): (Headers) ⇒ Validated[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  108. def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  109. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  110. final def patch[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  111. val path: Path[Unit]
    Definition Classes
    Urls
  112. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  113. final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  114. final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  115. def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  116. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  117. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  118. def redirect[A](other: ⇒ Endpoint[A, _])(args: A): Response[Unit]

    other

    Endpoint to redirect to

    args

    Arguments to pass to the endpoint to generate its URL

    returns

    An HTTP response redirecting to another endpoint (using 303 code status).

    Definition Classes
    EndpointsWithCustomErrors
  119. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  120. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: scala.collection.compat.Factory[A, CC[A]]): QueryStringParam[CC[A]]
    Definition Classes
    Urls → Urls
  121. def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B], docs: Documentation, headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]

    Decodes a request.

    Decodes a request.

    url

    Request URL

    entity

    Request entity

    docs

    Request documentation

    headers

    Request headers

    Definition Classes
    EndpointsWithCustomErrors → Requests
  122. implicit def requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  123. def requestHeader(name: String, docs: Option[String]): (Headers) ⇒ Validated[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  124. implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  125. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  126. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  127. def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  128. implicit lazy val responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  129. def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  130. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  131. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  132. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  133. def routesFromEndpoints(endpoints: ToPlayHandler*): PartialFunction[RequestHeader, Handler]

    Builds a Play router out of endpoint definitions.

    Builds a Play router out of endpoint definitions.

    val routes = routesFromEndpoints(
  inc.implementedBy(x => x + 1)
)
    Definition Classes
    EndpointsWithCustomErrors
  134. def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  135. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  136. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  137. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  138. implicit lazy val stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  139. implicit def stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  140. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  141. def textChunksRequest: RequestEntity[Chunks[String]]
    Definition Classes
    ChunkedEntities → ChunkedRequestEntities
  142. def textChunksResponse: ResponseEntity[Chunks[String]]
    Definition Classes
    ChunkedEntities → ChunkedResponseEntities
  143. lazy val textRequest: RequestEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  144. def textResponse: ResponseEntity[String]

    A text entity

    A text entity

    Definition Classes
    EndpointsWithCustomErrors → Responses
  145. def toString(): String
    Definition Classes
    AnyRef → Any
  146. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  147. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  148. val utf8Name: String
    Definition Classes
    Urls
  149. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  150. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  151. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  152. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  153. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  154. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses
  155. object EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors

Inherited from JsonEntitiesFromCodecs

Inherited from algebra.JsonEntitiesFromCodecs

Inherited from algebra.ChunkedJsonEntities

Inherited from ChunkedJsonResponseEntities

Inherited from ChunkedJsonRequestEntities

Inherited from algebra.Framing

Inherited from JsonCodecs

Inherited from JsonEntities

Inherited from ChunkedEntities

Inherited from algebra.ChunkedEntities

Inherited from ChunkedResponseEntities

Inherited from ChunkedRequestEntities

Inherited from algebra.Chunks

Inherited from EndpointsWithCustomErrors

Inherited from StatusCodes

Inherited from Methods

Inherited from Urls

Inherited from algebra.EndpointsWithCustomErrors

Inherited from Errors

Inherited from Responses

Inherited from algebra.StatusCodes

Inherited from Requests

Inherited from endpoints4s.SemigroupalSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from endpoints4s.PartialInvariantFunctorSyntax

Inherited from endpoints4s.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

Ungrouped