trait MuxEndpoints extends algebra.MuxEndpoints with EndpointsWithCustomErrors

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MuxEndpoints
  2. EndpointsWithCustomErrors
  3. Methods
  4. Urls
  5. StatusCodes
  6. MuxEndpoints
  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. All

Type Members

  1. final class Endpoint[A, B] extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors
  2. final class CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  3. type CallbacksDocs = Map[String, CallbackDocs]
    Definition Classes
    EndpointsWithCustomErrors
  4. abstract type ClientErrors
    Definition Classes
    Errors
  5. abstract type Effect[A]
    Definition Classes
    EndpointsWithCustomErrors
  6. final class EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  7. implicit final class EndpointSyntax[A, B] extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors
  8. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  9. type Method = org.http4s.Method
    Definition Classes
    Methods → Methods
  10. class MuxEndpoint[Req <: MuxRequest, Resp, Transport] extends AnyRef
  11. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  12. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  13. type QueryString[A] = (A) ⇒ Query
    Definition Classes
    Urls → Urls
  14. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  15. type Request[A] = (A) ⇒ Effect[org.http4s.Request[Effect]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  16. type RequestEntity[A] = (A, org.http4s.Request[Effect]) ⇒ org.http4s.Request[Effect]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  17. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  18. type RequestHeaders[A] = (A, org.http4s.Request[Effect]) ⇒ org.http4s.Request[Effect]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  19. implicit final class RequestSyntax[A] extends AnyRef
    Definition Classes
    Requests
  20. type Response[A] = (StatusCode, Headers) ⇒ Option[ResponseEntity[A]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  21. type ResponseEntity[A] = (org.http4s.Response[Effect]) ⇒ Effect[A]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  22. type ResponseHeaders[A] = (Headers) ⇒ Validated[A]
    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 = Status
    Definition Classes
    StatusCodes → StatusCodes
  27. type WithDefault[A] = Option[A]
    Definition Classes
    Urls → Urls
  28. trait Path[A] extends Url[A]
    Definition Classes
    Urls
  29. trait QueryStringParam[A] extends AnyRef
    Definition Classes
    Urls
  30. trait Segment[A] extends AnyRef
    Definition Classes
    Urls
  31. trait Url[A] extends AnyRef
    Definition Classes
    Urls

Abstract Value Members

  1. abstract def authority: Authority

    The authority to use to access the endpoints

    The authority to use to access the endpoints

    Definition Classes
    EndpointsWithCustomErrors
  2. abstract def client: Client[Effect]
    Definition Classes
    EndpointsWithCustomErrors
  3. abstract def clientErrorsResponseEntity: ResponseEntity[ClientErrors]
    Definition Classes
    Errors
  4. abstract def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
    Definition Classes
    Errors
  5. implicit abstract def effect: Concurrent[Effect]
    Definition Classes
    EndpointsWithCustomErrors
  6. abstract def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    Errors
  7. abstract def scheme: Scheme

    The scheme to use to access the endpoints

    The scheme to use to access the endpoints

    Definition Classes
    EndpointsWithCustomErrors
  8. abstract def serverErrorResponseEntity: ResponseEntity[ServerError]
    Definition Classes
    Errors
  9. abstract def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    Errors
  10. 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: Status
    Definition Classes
    StatusCodes → StatusCodes
  5. def AlreadyReported: Status
    Definition Classes
    StatusCodes → StatusCodes
  6. def BadRequest: Status
    Definition Classes
    StatusCodes → StatusCodes
  7. def Conflict: Status
    Definition Classes
    StatusCodes → StatusCodes
  8. def Created: Status
    Definition Classes
    StatusCodes → StatusCodes
  9. def Delete: Method
    Definition Classes
    Methods → Methods
  10. def ExpectationFailed: Status
    Definition Classes
    StatusCodes → StatusCodes
  11. def FailedDependency: Status
    Definition Classes
    StatusCodes → StatusCodes
  12. def Forbidden: Status
    Definition Classes
    StatusCodes → StatusCodes
  13. def Get: Method
    Definition Classes
    Methods → Methods
  14. def Gone: Status
    Definition Classes
    StatusCodes → StatusCodes
  15. def IMUsed: Status
    Definition Classes
    StatusCodes → StatusCodes
  16. def InternalServerError: Status
    Definition Classes
    StatusCodes → StatusCodes
  17. def LengthRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  18. def Locked: Status
    Definition Classes
    StatusCodes → StatusCodes
  19. def MethodNotAllowed: Status
    Definition Classes
    StatusCodes → StatusCodes
  20. def MisdirectedRequest: Status
    Definition Classes
    StatusCodes → StatusCodes
  21. def MultiStatus: Status
    Definition Classes
    StatusCodes → StatusCodes
  22. def NoContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  23. def NonAuthoritativeInformation: Status
    Definition Classes
    StatusCodes → StatusCodes
  24. def NotAcceptable: Status
    Definition Classes
    StatusCodes → StatusCodes
  25. def NotFound: Status
    Definition Classes
    StatusCodes → StatusCodes
  26. def NotImplemented: Status
    Definition Classes
    StatusCodes → StatusCodes
  27. def NotModified: Status
    Definition Classes
    StatusCodes → StatusCodes
  28. def OK: Status
    Definition Classes
    StatusCodes → StatusCodes
  29. def Options: Method
    Definition Classes
    Methods → Methods
  30. def PartialContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  31. def Patch: Method
    Definition Classes
    Methods → Methods
  32. def PayloadTooLarge: Status
    Definition Classes
    StatusCodes → StatusCodes
  33. def PaymentRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  34. def Post: Method
    Definition Classes
    Methods → Methods
  35. def PreconditionFailed: Status
    Definition Classes
    StatusCodes → StatusCodes
  36. def PreconditionRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  37. def ProxyAuthenticationRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  38. def Put: Method
    Definition Classes
    Methods → Methods
  39. def RangeNotSatisfiable: Status
    Definition Classes
    StatusCodes → StatusCodes
  40. def RequestHeaderFieldsTooLarge: Status
    Definition Classes
    StatusCodes → StatusCodes
  41. def RequestTimeout: Status
    Definition Classes
    StatusCodes → StatusCodes
  42. def ResetContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  43. def TooEarly: Status
    Definition Classes
    StatusCodes → StatusCodes
  44. def TooManyRequests: Status
    Definition Classes
    StatusCodes → StatusCodes
  45. def Unauthorized: Status
    Definition Classes
    StatusCodes → StatusCodes
  46. def UnavailableForLegalReasons: Status
    Definition Classes
    StatusCodes → StatusCodes
  47. def UnprocessableEntity: Status
    Definition Classes
    StatusCodes → StatusCodes
  48. def UnsupportedMediaType: Status
    Definition Classes
    StatusCodes → StatusCodes
  49. def UpgradeRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  50. def UriTooLong: Status
    Definition Classes
    StatusCodes → StatusCodes
  51. def addRequestHeaders[A, H](request: Request[A], headers: RequestHeaders[H])(implicit tupler: Tupler[A, H]): Request[Out]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  52. def addRequestQueryString[A, Q](request: Request[A], qs: QueryString[Q])(implicit tupler: Tupler[A, Q]): Request[Out]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  53. def addResponseHeaders[A, H](response: Response[A], headers: ResponseHeaders[H])(implicit tupler: Tupler[A, H]): Response[Out]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  54. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  55. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  56. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  57. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  58. def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  59. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  60. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  61. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  62. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  63. 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
  64. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  65. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  66. def emptyRequest: RequestEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  67. def emptyRequestHeaders: RequestHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  68. def emptyResponse: ResponseEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  69. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  70. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  71. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  72. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  73. 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
  74. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  75. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  76. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  77. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  78. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  79. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  80. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  81. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  82. def mapEndpointDocs[A, B](currentEndpoint: Endpoint[A, B], func: (EndpointDocs) ⇒ EndpointDocs): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  83. def mapEndpointRequest[A, B, C](currentEndpoint: Endpoint[A, B], func: (Request[A]) ⇒ Request[C]): Endpoint[C, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  84. def mapEndpointResponse[A, B, C](currentEndpoint: Endpoint[A, B], func: (Response[B]) ⇒ Response[C]): Endpoint[A, C]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  85. def muxEndpoint[Req <: MuxRequest, Resp, Transport](request: Request[Transport], response: Response[Transport]): MuxEndpoint[Req, Resp, Transport]
    Definition Classes
    MuxEndpoints → MuxEndpoints
  86. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  87. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  88. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  89. 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
  90. def optQsWithDefault[A](name: String, default: A, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[WithDefault[A]]
    Definition Classes
    Urls → Urls
  91. def optRequestHeader(name: String, docs: Option[String]): RequestHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  92. def optResponseHeader(name: String, docs: Option[String]): ResponseHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  93. def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  94. 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
  95. val path: Path[Unit]
    Definition Classes
    Urls
  96. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  97. 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
  98. 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
  99. def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  100. def queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  101. def queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  102. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  103. 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
  104. def request[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](method: Method, 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
    EndpointsWithCustomErrors → Requests
  105. implicit def requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  106. def requestHeader(name: String, docs: Option[String]): RequestHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  107. implicit def requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  108. implicit def requestHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  109. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  110. def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  111. implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  112. def responseHeader(name: String, docs: Option[String]): ResponseHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  113. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  114. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  115. implicit def responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  116. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  117. def segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  118. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  119. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  120. def stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  121. def stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  122. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  123. def textRequest: RequestEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  124. def textResponse: ResponseEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  125. def toString(): String
    Definition Classes
    AnyRef → Any
  126. def urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  127. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  128. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  129. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  130. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  131. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  132. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  133. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses

Deprecated Value Members

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

Inherited from EndpointsWithCustomErrors

Inherited from Methods

Inherited from Urls

Inherited from StatusCodes

Inherited from algebra.MuxEndpoints

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