Packages

t

endpoints4s.akkahttp.client

EndpointsWithCustomErrors

trait EndpointsWithCustomErrors extends algebra.EndpointsWithCustomErrors with Urls with Methods with StatusCodes

Akka-HTTP based interpreter.

Source
Endpoints.scala
Linear Supertypes
StatusCodes, Methods, Urls, algebra.EndpointsWithCustomErrors, Errors, Responses, algebra.StatusCodes, Requests, endpoints4s.SemigroupalSyntax, algebra.Methods, algebra.Urls, endpoints4s.PartialInvariantFunctorSyntax, endpoints4s.InvariantFunctorSyntax, AnyRef, Any
Known Subclasses
ChunkedEntities, ChunkedJsonEntities, Endpoints, JsonEntitiesFromCodecs, JsonEntitiesFromSchemas
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EndpointsWithCustomErrors
  2. StatusCodes
  3. Methods
  4. Urls
  5. EndpointsWithCustomErrors
  6. Errors
  7. Responses
  8. StatusCodes
  9. Requests
  10. SemigroupalSyntax
  11. Methods
  12. Urls
  13. PartialInvariantFunctorSyntax
  14. InvariantFunctorSyntax
  15. AnyRef
  16. 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. final class CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  2. type CallbacksDocs = Map[String, CallbackDocs]
    Definition Classes
    EndpointsWithCustomErrors
  3. abstract type ClientErrors
    Definition Classes
    Errors
  4. case class Endpoint[A, B](request: Request[A], response: Response[B]) extends (A) => Future[B] with Product with Serializable
  5. final class EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  6. implicit final class EndpointSyntax[A, B] extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors
  7. case class InvalidHeaderDefinition(parsingResult: ParsingResult) extends RuntimeException with Product with Serializable
  8. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  9. type Method = (HttpRequest) => HttpRequest
    Definition Classes
    Methods → Methods
  10. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  11. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  12. type QueryStringParam[A] = (A) => List[String]

    a query string parameter can have zero or several values

    a query string parameter can have zero or several values

    Definition Classes
    Urls → Urls
  13. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  14. type Request[A] = (A) => Future[HttpRequest]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  15. type RequestEntity[A] = (A, HttpRequest) => HttpRequest
    Definition Classes
    EndpointsWithCustomErrors → Requests
  16. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  17. type RequestHeaders[A] = (A, List[HttpHeader]) => List[HttpHeader]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  18. implicit final class RequestSyntax[A] extends AnyRef
    Definition Classes
    Requests
  19. type Response[A] = (StatusCode, Seq[HttpHeader]) => Option[ResponseEntity[A]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  20. type ResponseEntity[A] = (HttpEntity) => Future[Either[Throwable, A]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  21. type ResponseHeaders[A] = (Seq[HttpHeader]) => Validated[A]
    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 = akka.http.scaladsl.model.StatusCode
    Definition Classes
    StatusCodes → StatusCodes
  26. type WithDefault[A] = Option[A]
    Definition Classes
    Urls → Urls
  27. trait Path[A] extends Url[A]
    Definition Classes
    Urls
  28. trait QueryString[A] extends AnyRef
    Definition Classes
    Urls
  29. trait Segment[A] extends AnyRef
    Definition Classes
    Urls
  30. trait Url[A] extends AnyRef
    Definition Classes
    Urls

Abstract Value Members

  1. implicit abstract def EC: ExecutionContext
  2. implicit abstract def M: Materializer
  3. abstract def clientErrorsResponseEntity: ResponseEntity[ClientErrors]
    Definition Classes
    Errors
  4. abstract def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
    Definition Classes
    Errors
  5. abstract def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    Errors
  6. abstract def serverErrorResponseEntity: ResponseEntity[ServerError]
    Definition Classes
    Errors
  7. abstract def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    Errors
  8. abstract def settings: EndpointsSettings
  9. abstract def throwableToServerError(throwable: Throwable): ServerError
    Definition Classes
    Errors

Concrete Value Members

  1. def Accepted: Success
    Definition Classes
    StatusCodes → StatusCodes
  2. def AlreadyReported: Success
    Definition Classes
    StatusCodes → StatusCodes
  3. def BadRequest: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  4. def Conflict: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  5. def Created: Success
    Definition Classes
    StatusCodes → StatusCodes
  6. def Delete: (HttpRequest) => HttpRequest
    Definition Classes
    Methods → Methods
  7. def ExpectationFailed: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  8. def FailedDependency: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  9. def Forbidden: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  10. def Get: (HttpRequest) => HttpRequest
    Definition Classes
    Methods → Methods
  11. def Gone: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  12. def IMUsed: Success
    Definition Classes
    StatusCodes → StatusCodes
  13. def InternalServerError: akka.http.scaladsl.model.StatusCodes.ServerError
    Definition Classes
    StatusCodes → StatusCodes
  14. def LengthRequired: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  15. def Locked: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  16. def MethodNotAllowed: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  17. def MisdirectedRequest: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  18. def MultiStatus: Success
    Definition Classes
    StatusCodes → StatusCodes
  19. def NoContent: Success
    Definition Classes
    StatusCodes → StatusCodes
  20. def NonAuthoritativeInformation: Success
    Definition Classes
    StatusCodes → StatusCodes
  21. def NotAcceptable: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  22. def NotFound: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  23. def NotImplemented: akka.http.scaladsl.model.StatusCodes.ServerError
    Definition Classes
    StatusCodes → StatusCodes
  24. def NotModified: Redirection
    Definition Classes
    StatusCodes → StatusCodes
  25. def OK: Success
    Definition Classes
    StatusCodes → StatusCodes
  26. def Options: (HttpRequest) => HttpRequest
    Definition Classes
    Methods → Methods
  27. def PartialContent: Success
    Definition Classes
    StatusCodes → StatusCodes
  28. def Patch: (HttpRequest) => HttpRequest
    Definition Classes
    Methods → Methods
  29. def PayloadTooLarge: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  30. def PaymentRequired: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  31. def PermanentRedirect: Redirection
    Definition Classes
    StatusCodes → StatusCodes
  32. def Post: (HttpRequest) => HttpRequest
    Definition Classes
    Methods → Methods
  33. def PreconditionFailed: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  34. def PreconditionRequired: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  35. def ProxyAuthenticationRequired: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  36. def Put: (HttpRequest) => HttpRequest
    Definition Classes
    Methods → Methods
  37. def RangeNotSatisfiable: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  38. def RequestHeaderFieldsTooLarge: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  39. def RequestTimeout: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  40. def ResetContent: Success
    Definition Classes
    StatusCodes → StatusCodes
  41. def TemporaryRedirect: Redirection
    Definition Classes
    StatusCodes → StatusCodes
  42. def TooEarly: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  43. def TooManyRequests: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  44. def Unauthorized: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  45. def UnavailableForLegalReasons: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  46. def UnprocessableEntity: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  47. def UnsupportedMediaType: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  48. def UpgradeRequired: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  49. def UriTooLong: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  50. def addRequestHeaders[A, H](request: Request[A], headers: RequestHeaders[H])(implicit tupler: Tupler[A, H]): Request[Out]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  51. def addRequestQueryString[A, B](request: Request[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Request[Out]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  52. def addResponseHeaders[A, H](response: Response[A], headers: ResponseHeaders[H])(implicit tupler: Tupler[A, H]): Response[Out]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  53. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  54. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  55. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  56. def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  57. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  58. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  59. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  60. 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
  61. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  62. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  63. lazy val emptyRequest: RequestEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  64. lazy val emptyRequestHeaders: RequestHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  65. def emptyResponse: ResponseEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  66. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  67. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  68. 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
  69. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  70. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  71. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  72. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  73. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  74. def mapEndpointDocs[A, B](currentEndpoint: Endpoint[A, B], func: (EndpointDocs) => EndpointDocs): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  75. def mapEndpointRequest[A, B, C](currentEndpoint: Endpoint[A, B], func: (Request[A]) => Request[C]): Endpoint[C, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  76. def mapEndpointResponse[A, B, C](currentEndpoint: Endpoint[A, B], func: (Response[B]) => Response[C]): Endpoint[A, C]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  77. 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
  78. def optQsWithDefault[A](name: String, default: A, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[WithDefault[A]]
    Definition Classes
    Urls → Urls
  79. def optRequestHeader(name: String, docs: Option[String]): (Option[String], List[HttpHeader]) => List[HttpHeader]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  80. def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  81. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  82. 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
  83. val path: Path[Unit]
    Definition Classes
    Urls
  84. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  85. 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
  86. 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
  87. def qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  88. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  89. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  90. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  91. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]
    Definition Classes
    Urls → Urls
  92. 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]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  93. implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  94. def requestHeader(name: String, docs: Option[String]): (String, List[HttpHeader]) => List[HttpHeader]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  95. implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  96. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  97. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  98. def response[A, B, R](statusCode: StatusCode, responseEntity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  99. implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  100. def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  101. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  102. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  103. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  104. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  105. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  106. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  107. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  108. def stringCodecResponse[A](implicit codec: Decoder[String, A]): ResponseEntity[A]
  109. implicit lazy val stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  110. implicit lazy val stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  111. lazy val textRequest: (String, HttpRequest) => HttpRequest
    Definition Classes
    EndpointsWithCustomErrors → Requests
  112. def textResponse: ResponseEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  113. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  114. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  115. val utf8Name: String
    Definition Classes
    Urls
  116. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  117. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  118. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses
  119. object EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors