Packages

trait Assets extends algebra.Assets with EndpointsWithCustomErrors

Interpreter for algebra.Assets that performs routing using Play framework

Linear Supertypes
EndpointsWithCustomErrors, StatusCodes, Methods, Urls, algebra.Assets, 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. Assets
  2. EndpointsWithCustomErrors
  3. StatusCodes
  4. Methods
  5. Urls
  6. Assets
  7. EndpointsWithCustomErrors
  8. Errors
  9. Responses
  10. StatusCodes
  11. Requests
  12. SemigroupalSyntax
  13. Methods
  14. Urls
  15. PartialInvariantFunctorSyntax
  16. InvariantFunctorSyntax
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class AssetPath(path: Seq[String], digest: String, name: String) extends Product with Serializable

    // foo/bar/baz-123abc
AssetPath("foo" :: "bar" :: Nil, "123abc", "baz")
  2. case class AssetRequest(assetPath: AssetPath, isGzipSupported: Boolean) extends Product with Serializable

    assetPath

    Path of the requested asset

    isGzipSupported

    Whether the client supports gzip encoding or not

  3. sealed trait AssetResponse extends AnyRef

    An AssetResponse is either AssetNotFound (if the asset has not been found on the server) or Found otherwise.

  4. final class CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  5. type CallbacksDocs = Map[String, CallbackDocs]
    Definition Classes
    EndpointsWithCustomErrors
  6. abstract type ClientErrors
    Definition Classes
    Errors
  7. final class EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  8. implicit final class EndpointSyntax[A, B] extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors
  9. case class Found(data: Source[ByteString, _], contentLength: Option[Long], contentType: Option[String], isGzipped: Boolean) extends AssetResponse with Product with Serializable

    data

    Asset content

    contentLength

    Size, if known

    contentType

    Content type, if known

    isGzipped

    Whether data contains the gzipped version of the asset

  10. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  11. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  12. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  13. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  14. type RequestEntity[A] = (RequestHeader) => Option[BodyParser[A]]

    Decodes a request entity

    Decodes a request entity

    Definition Classes
    EndpointsWithCustomErrors → Requests
  15. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  16. 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
  17. 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
  18. implicit final class RequestSyntax[A] extends AnyRef
    Definition Classes
    Requests
  19. 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
  20. type ResponseEntity[A] = (A) => HttpEntity
    Definition Classes
    EndpointsWithCustomErrors → Responses
  21. type ResponseHeaders[A] = (A) => Seq[(String, String)]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  22. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  23. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  24. abstract type ServerError
    Definition Classes
    Errors
  25. type StatusCode = play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  26. type WithDefault[A] = A
    Definition Classes
    Urls → Urls
  27. 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
  28. 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
  29. trait Request[A] extends AnyRef

    An HTTP request.

    An HTTP request.

    Has an instance of InvariantFunctor.

    Definition Classes
    EndpointsWithCustomErrors
  30. 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
  31. case class Method(value: String) extends Product with Serializable
    Definition Classes
    Methods
  32. implicit final class ApplicativeMapSyntax[F[_], A] extends AnyRef
    Definition Classes
    Urls
  33. trait Path[A] extends EndpointsWithCustomErrors.Url[A]
    Definition Classes
    Urls
  34. trait QueryString[A] extends AnyRef

    Query string encoding and decoding

    Query string encoding and decoding

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

    Defines how to decode and encode path segments

    Defines how to decode and encode path segments

    Definition Classes
    Urls
  37. 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 digests: Map[String, String]
    Definition Classes
    Assets
  4. abstract def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    Errors
  5. abstract val playComponents: PlayComponents
    Definition Classes
    EndpointsWithCustomErrors
  6. abstract def serverErrorResponseEntity: ResponseEntity[ServerError]
    Definition Classes
    Errors
  7. abstract def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    Errors
  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 PermanentRedirect: StatusCode
    Definition Classes
    StatusCodes
  36. def Post: Method
    Definition Classes
    Methods → Methods
  37. def PreconditionFailed: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  38. def PreconditionRequired: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  39. def ProxyAuthenticationRequired: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  40. def Put: Method
    Definition Classes
    Methods → Methods
  41. def RangeNotSatisfiable: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  42. def RequestHeaderFieldsTooLarge: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  43. def RequestTimeout: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  44. def ResetContent: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  45. def TemporaryRedirect: StatusCode
    Definition Classes
    StatusCodes
  46. def TooEarly: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  47. def TooManyRequests: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  48. def Unauthorized: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  49. def UnavailableForLegalReasons: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  50. def UnprocessableEntity: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  51. def UnsupportedMediaType: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  52. def UpgradeRequired: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  53. def UriTooLong: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  54. def addRequestHeaders[A, H](request: Request[A], headersP: RequestHeaders[H])(implicit tupler: Tupler[A, H]): Request[Out]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  55. def addRequestQueryString[A, Q](request: Request[A], qs: QueryString[Q])(implicit tupler: Tupler[A, Q]): Request[Out]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  56. def addResponseHeaders[A, H](response: Response[A], headers: ResponseHeaders[H])(implicit tupler: Tupler[A, H]): Response[Out]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  57. implicit lazy val applicativeRequestExtractor: Applicative[RequestExtractor]
    Definition Classes
    Urls
  58. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  59. def asset(path: String, name: String): AssetRequest

    Convenient constructor for building an asset from its name and path, without providing its digest.

    Convenient constructor for building an asset from its name and path, without providing its digest.

    Useful for reverse routing:

    myAssetsEndpoint.call(asset("foo/bar", "baz"))
    path

    Asset path (no leading nor trailing slash)

    name

    Asset name

    returns

    An AssetRequest describing the asset. Throws an exception if there is no digest for name.

  60. def asset(name: String): AssetRequest

    Convenient constructor for building an asset from its name, without providing its digest.

    Convenient constructor for building an asset from its name, without providing its digest.

    Useful for reverse routing:

    myAssetsEndpoint.call(asset("baz"))
    name

    Asset name

    returns

    An AssetRequest describing the asset. There is no path prefixing the name. Throws an exception if there is no digest for name.

  61. def assetSegments(name: String, docs: Documentation): Path[AssetPath]

    Decodes and encodes an AssetPath into a URL path.

    Decodes and encodes an AssetPath into a URL path.

    Definition Classes
    Assets → Assets
  62. def assetsEndpoint(url: Url[AssetPath], docs: Documentation, notFoundDocs: Documentation): Endpoint[AssetRequest, AssetResponse]

    An endpoint for serving assets.

    An endpoint for serving assets.

    url

    URL description

    returns

    An HTTP endpoint serving assets

    Definition Classes
    Assets → Assets
  63. def assetsResources(pathPrefix: Option[String] = None): (AssetRequest) => AssetResponse

    pathPrefix

    Prefix to use to look up the resources in the classpath. You most probably never want to publish all your classpath resources.

    returns

    A function that, given an AssetRequest, builds an AssetResponse by looking for the requested asset in the classpath resources.

  64. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  65. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  66. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  67. def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  68. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  69. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  70. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  71. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  72. 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
  73. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  74. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  75. lazy val emptyRequest: RequestEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  76. 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
  77. def emptyResponse: ResponseEntity[Unit]

    An empty response entity

    An empty response entity

    Definition Classes
    EndpointsWithCustomErrors → Responses
  78. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  79. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  80. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  81. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  82. implicit lazy val functorRequestExtractor: Functor[RequestExtractor]
    Definition Classes
    Urls
  83. 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
  84. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  85. 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
  86. 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
  87. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  88. 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
  89. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  90. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  91. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  92. implicit lazy val invariantFunctorRequest: play.api.libs.functional.InvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors
  93. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  94. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  95. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  96. def mapEndpointDocs[A, B](endpoint: Endpoint[A, B], func: (EndpointDocs) => EndpointDocs): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  97. def mapEndpointRequest[A, B, C](endpoint: Endpoint[A, B], func: (Request[A]) => Request[C]): Endpoint[C, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  98. def mapEndpointResponse[A, B, C](endpoint: Endpoint[A, B], func: (Response[B]) => Response[C]): Endpoint[A, C]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  99. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  100. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  101. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  102. 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
  103. def optQsWithDefault[A](name: String, default: A, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[WithDefault[A]]
    Definition Classes
    Urls → Urls
  104. def optRequestHeader(name: String, docs: Option[String]): (Headers) => Validated[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  105. def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  106. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  107. 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
  108. val path: Path[Unit]
    Definition Classes
    Urls
  109. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  110. 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
  111. 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
  112. def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  113. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  114. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  115. 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
  116. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  117. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]
    Definition Classes
    Urls → Urls
  118. 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
  119. implicit def requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  120. def requestHeader(name: String, docs: Option[String]): (Headers) => Validated[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  121. implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  122. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  123. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  124. 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
  125. implicit lazy val responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  126. def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  127. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  128. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  129. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  130. 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
  131. def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  132. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  133. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  134. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  135. implicit lazy val stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  136. implicit def stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  137. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  138. lazy val textRequest: RequestEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  139. def textResponse: ResponseEntity[String]

    A text entity

    A text entity

    Definition Classes
    EndpointsWithCustomErrors → Responses
  140. def toString(): String
    Definition Classes
    AnyRef → Any
  141. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  142. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  143. val utf8Name: String
    Definition Classes
    Urls
  144. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  145. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  146. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  147. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  148. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  149. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses
  150. case object AssetNotFound extends AssetResponse with Product with Serializable
  151. object EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors

Deprecated Value Members

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

    (Since version 9)

Inherited from EndpointsWithCustomErrors

Inherited from StatusCodes

Inherited from Methods

Inherited from Urls

Inherited from algebra.Assets

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