Packages

class Endpoints extends algebra.Endpoints with EndpointsWithCustomErrors with BuiltInErrors

Akka-HTTP based interpreter that uses algebra.BuiltInErrors to model client and server errors.

Source
Endpoints.scala
Linear Supertypes
BuiltInErrors, EndpointsWithCustomErrors, StatusCodes, Methods, Urls, algebra.Endpoints, algebra.BuiltInErrors, algebra.EndpointsWithCustomErrors, Errors, Responses, algebra.StatusCodes, Requests, endpoints4s.SemigroupalSyntax, algebra.Methods, algebra.Urls, endpoints4s.PartialInvariantFunctorSyntax, endpoints4s.InvariantFunctorSyntax, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Endpoints
  2. BuiltInErrors
  3. EndpointsWithCustomErrors
  4. StatusCodes
  5. Methods
  6. Urls
  7. Endpoints
  8. BuiltInErrors
  9. EndpointsWithCustomErrors
  10. Errors
  11. Responses
  12. StatusCodes
  13. Requests
  14. SemigroupalSyntax
  15. Methods
  16. Urls
  17. PartialInvariantFunctorSyntax
  18. InvariantFunctorSyntax
  19. AnyRef
  20. 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

Instance Constructors

  1. new Endpoints(settings: EndpointsSettings)(implicit EC: ExecutionContext, M: Materializer)

Type Members

  1. final class CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  2. type CallbacksDocs = Map[String, CallbackDocs]
    Definition Classes
    EndpointsWithCustomErrors
  3. type ClientErrors = Invalid
    Definition Classes
    BuiltInErrors → Errors
  4. final class EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  5. implicit final class EndpointSyntax[A, B] extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors
  6. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  7. type Method = (HttpRequest) => HttpRequest
    Definition Classes
    Methods → Methods
  8. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  9. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  10. 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
  11. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  12. type Request[A] = (A) => Future[HttpRequest]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  13. type RequestEntity[A] = (A, HttpRequest) => HttpRequest
    Definition Classes
    EndpointsWithCustomErrors → Requests
  14. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  15. type RequestHeaders[A] = (A, List[HttpHeader]) => List[HttpHeader]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  16. implicit final class RequestSyntax[A] extends AnyRef
    Definition Classes
    Requests
  17. type Response[A] = (StatusCode, Seq[HttpHeader]) => Option[ResponseEntity[A]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  18. type ResponseEntity[A] = (HttpEntity) => Future[Either[Throwable, A]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  19. type ResponseHeaders[A] = (Seq[HttpHeader]) => Validated[A]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  20. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  21. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  22. type ServerError = Throwable
    Definition Classes
    BuiltInErrors → Errors
  23. type StatusCode = akka.http.scaladsl.model.StatusCode
    Definition Classes
    StatusCodes → StatusCodes
  24. type WithDefault[A] = Option[A]
    Definition Classes
    Urls → Urls
  25. case class Endpoint[A, B](request: Request[A], response: Response[B]) extends (A) => Future[B] with Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  26. case class InvalidHeaderDefinition(parsingResult: ParsingResult) extends RuntimeException with Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Endpoints toany2stringadd[Endpoints] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Endpoints, B)
    Implicit
    This member is added by an implicit conversion from Endpoints toArrowAssoc[Endpoints] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def Accepted: Success
    Definition Classes
    StatusCodes → StatusCodes
  7. def AlreadyReported: Success
    Definition Classes
    StatusCodes → StatusCodes
  8. def BadRequest: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  9. def Conflict: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  10. def Created: Success
    Definition Classes
    StatusCodes → StatusCodes
  11. def Delete: (HttpRequest) => HttpRequest
    Definition Classes
    Methods → Methods
  12. implicit val EC: ExecutionContext
    Definition Classes
    Endpoints → EndpointsWithCustomErrors
  13. def ExpectationFailed: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  14. def FailedDependency: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  15. def Forbidden: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  16. def Get: (HttpRequest) => HttpRequest
    Definition Classes
    Methods → Methods
  17. def Gone: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  18. def IMUsed: Success
    Definition Classes
    StatusCodes → StatusCodes
  19. def InternalServerError: akka.http.scaladsl.model.StatusCodes.ServerError
    Definition Classes
    StatusCodes → StatusCodes
  20. def LengthRequired: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  21. def Locked: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  22. implicit val M: Materializer
    Definition Classes
    Endpoints → EndpointsWithCustomErrors
  23. def MethodNotAllowed: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  24. def MisdirectedRequest: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  25. def MultiStatus: Success
    Definition Classes
    StatusCodes → StatusCodes
  26. def NoContent: Success
    Definition Classes
    StatusCodes → StatusCodes
  27. def NonAuthoritativeInformation: Success
    Definition Classes
    StatusCodes → StatusCodes
  28. def NotAcceptable: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  29. def NotFound: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  30. def NotImplemented: akka.http.scaladsl.model.StatusCodes.ServerError
    Definition Classes
    StatusCodes → StatusCodes
  31. def NotModified: Redirection
    Definition Classes
    StatusCodes → StatusCodes
  32. def OK: Success
    Definition Classes
    StatusCodes → StatusCodes
  33. def Options: (HttpRequest) => HttpRequest
    Definition Classes
    Methods → Methods
  34. def PartialContent: Success
    Definition Classes
    StatusCodes → StatusCodes
  35. def Patch: (HttpRequest) => HttpRequest
    Definition Classes
    Methods → Methods
  36. def PayloadTooLarge: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  37. def PaymentRequired: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  38. def PermanentRedirect: Redirection
    Definition Classes
    StatusCodes → StatusCodes
  39. def Post: (HttpRequest) => HttpRequest
    Definition Classes
    Methods → Methods
  40. def PreconditionFailed: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  41. def PreconditionRequired: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  42. def ProxyAuthenticationRequired: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  43. def Put: (HttpRequest) => HttpRequest
    Definition Classes
    Methods → Methods
  44. def RangeNotSatisfiable: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  45. def RequestHeaderFieldsTooLarge: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  46. def RequestTimeout: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  47. def ResetContent: Success
    Definition Classes
    StatusCodes → StatusCodes
  48. def TemporaryRedirect: Redirection
    Definition Classes
    StatusCodes → StatusCodes
  49. def TooEarly: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  50. def TooManyRequests: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  51. def Unauthorized: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  52. def UnavailableForLegalReasons: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  53. def UnprocessableEntity: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  54. def UnsupportedMediaType: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  55. def UpgradeRequired: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  56. def UriTooLong: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  57. def addRequestHeaders[A, H](request: Request[A], headers: RequestHeaders[H])(implicit tupler: Tupler[A, H]): Request[Out]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  58. def addRequestQueryString[A, B](request: Request[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Request[Out]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  59. def addResponseHeaders[A, H](response: Response[A], headers: ResponseHeaders[H])(implicit tupler: Tupler[A, H]): Response[Out]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  60. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  61. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  62. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  63. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  64. def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  65. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  66. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  67. def clientErrorsResponseEntity: ResponseEntity[Invalid]
    Definition Classes
    BuiltInErrors → BuiltInErrors → Errors
  68. final def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
    Definition Classes
    BuiltInErrors → Errors
  69. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  70. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  71. def createHeader(name: String, value: String): HttpHeader
    Attributes
    protected
    Definition Classes
    EndpointsWithCustomErrors
  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]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  77. def emptyResponse: ResponseEntity[Unit]
    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. def ensuring(cond: (Endpoints) => Boolean, msg: => Any): Endpoints
    Implicit
    This member is added by an implicit conversion from Endpoints toEnsuring[Endpoints] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  81. def ensuring(cond: (Endpoints) => Boolean): Endpoints
    Implicit
    This member is added by an implicit conversion from Endpoints toEnsuring[Endpoints] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  82. def ensuring(cond: Boolean, msg: => Any): Endpoints
    Implicit
    This member is added by an implicit conversion from Endpoints toEnsuring[Endpoints] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  83. def ensuring(cond: Boolean): Endpoints
    Implicit
    This member is added by an implicit conversion from Endpoints toEnsuring[Endpoints] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  84. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  85. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  86. 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
  87. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  88. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  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. final def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    BuiltInErrors → Errors
  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](currentEndpoint: Endpoint[A, B], func: (EndpointDocs) => EndpointDocs): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  97. def mapEndpointRequest[A, B, C](currentEndpoint: Endpoint[A, B], func: (Request[A]) => Request[C]): Endpoint[C, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  98. def mapEndpointResponse[A, B, C](currentEndpoint: 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
    @native() @HotSpotIntrinsicCandidate()
  101. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  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]): (Option[String], List[HttpHeader]) => List[HttpHeader]
    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 param: 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 remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  116. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]
    Definition Classes
    Urls → Urls
  117. 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
  118. implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  119. def requestHeader(name: String, docs: Option[String]): (String, List[HttpHeader]) => List[HttpHeader]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  120. implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  121. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  122. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  123. 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
  124. implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  125. def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  126. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  127. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  128. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  129. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  130. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  131. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  132. def serverErrorResponseEntity: ResponseEntity[Throwable]
    Definition Classes
    BuiltInErrors → BuiltInErrors → Errors
  133. final def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    BuiltInErrors → Errors
  134. val settings: EndpointsSettings
    Definition Classes
    Endpoints → EndpointsWithCustomErrors
  135. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  136. def stringCodecResponse[A](implicit codec: Decoder[String, A]): ResponseEntity[A]
    Definition Classes
    EndpointsWithCustomErrors
  137. implicit lazy val stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  138. implicit lazy val stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  139. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  140. lazy val textRequest: (String, HttpRequest) => HttpRequest
    Definition Classes
    EndpointsWithCustomErrors → Requests
  141. def textResponse: ResponseEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  142. final def throwableToServerError(throwable: Throwable): ServerError
    Definition Classes
    BuiltInErrors → Errors
  143. def toString(): String
    Definition Classes
    AnyRef → Any
  144. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  145. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  146. val utf8Name: String
    Definition Classes
    Urls
  147. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  148. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  149. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  150. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  151. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  152. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses
  153. 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
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Endpoints toStringFormat[Endpoints] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

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

  3. def →[B](y: B): (Endpoints, B)
    Implicit
    This member is added by an implicit conversion from Endpoints toArrowAssoc[Endpoints] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from BuiltInErrors

Inherited from EndpointsWithCustomErrors

Inherited from StatusCodes

Inherited from Methods

Inherited from Urls

Inherited from algebra.Endpoints

Inherited from algebra.BuiltInErrors

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

Inherited by implicit conversion any2stringadd fromEndpoints to any2stringadd[Endpoints]

Inherited by implicit conversion StringFormat fromEndpoints to StringFormat[Endpoints]

Inherited by implicit conversion Ensuring fromEndpoints to Ensuring[Endpoints]

Inherited by implicit conversion ArrowAssoc fromEndpoints to ArrowAssoc[Endpoints]

Ungrouped