Packages

trait Assets extends algebra.Assets with EndpointsWithCustomErrors

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Assets
  2. EndpointsWithCustomErrors
  3. Urls
  4. StatusCodes
  5. Methods
  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], name: String) extends Product with Serializable
  2. case class AssetRequest(assetPath: AssetPath, isGzipSupported: Boolean, ifModifiedSince: Option[HttpDate]) extends Product with Serializable
  3. sealed trait AssetResponse extends AnyRef
  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. abstract type Effect[A]
    Definition Classes
    EndpointsWithCustomErrorsUrls
  8. final class EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  9. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  10. type Method = org.http4s.Method
    Definition Classes
    Methods → Methods
  11. type Params = Map[String, Seq[String]]
    Definition Classes
    Urls
  12. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  13. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  14. type QueryString[A] = (Params) => Validated[A]
    Definition Classes
    Urls → Urls
  15. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  16. type Request[A] = PartialFunction[org.http4s.Request[Effect], Effect[Either[org.http4s.Response[Effect], A]]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  17. type RequestEntity[A] = (org.http4s.Request[Effect]) => Effect[Either[org.http4s.Response[Effect], A]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  18. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  19. type RequestHeaders[A] = (Headers) => Validated[A]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  20. type Response[A] = (A) => org.http4s.Response[Effect]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  21. type ResponseEntity[A] = EntityEncoder[Effect, A]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  22. type ResponseHeaders[A] = (A) => Headers
    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. case class Endpoint[A, B](request: Request[A], response: Response[B], operationId: Option[String]) extends Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  28. trait Path[A] extends EndpointsWithCustomErrors.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. implicit abstract def Effect: Sync[Effect]
    Definition Classes
    EndpointsWithCustomErrors
  2. abstract def clientErrorsResponseEntity: ResponseEntity[ClientErrors]
    Definition Classes
    Errors
  3. abstract def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
    Definition Classes
    Errors
  4. abstract def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    Errors
  5. abstract def serverErrorResponseEntity: ResponseEntity[ServerError]
    Definition Classes
    Errors
  6. abstract def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    Errors
  7. 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. val DefaultBufferSize: Int
  10. def Delete: Method
    Definition Classes
    Methods → Methods
  11. def ExpectationFailed: Status
    Definition Classes
    StatusCodes → StatusCodes
  12. def FailedDependency: Status
    Definition Classes
    StatusCodes → StatusCodes
  13. def Forbidden: Status
    Definition Classes
    StatusCodes → StatusCodes
  14. def Get: Method
    Definition Classes
    Methods → Methods
  15. def Gone: Status
    Definition Classes
    StatusCodes → StatusCodes
  16. def IMUsed: Status
    Definition Classes
    StatusCodes → StatusCodes
  17. def InternalServerError: Status
    Definition Classes
    StatusCodes → StatusCodes
  18. def LengthRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  19. def Locked: Status
    Definition Classes
    StatusCodes → StatusCodes
  20. def MethodNotAllowed: Status
    Definition Classes
    StatusCodes → StatusCodes
  21. def MisdirectedRequest: Status
    Definition Classes
    StatusCodes → StatusCodes
  22. def MultiStatus: Status
    Definition Classes
    StatusCodes → StatusCodes
  23. def NoContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  24. def NonAuthoritativeInformation: Status
    Definition Classes
    StatusCodes → StatusCodes
  25. def NotAcceptable: Status
    Definition Classes
    StatusCodes → StatusCodes
  26. def NotFound: Status
    Definition Classes
    StatusCodes → StatusCodes
  27. def NotImplemented: Status
    Definition Classes
    StatusCodes → StatusCodes
  28. def NotModified: Status
    Definition Classes
    StatusCodes → StatusCodes
  29. def OK: Status
    Definition Classes
    StatusCodes → StatusCodes
  30. def Options: Method
    Definition Classes
    Methods → Methods
  31. def PartialContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  32. def Patch: Method
    Definition Classes
    Methods → Methods
  33. def PayloadTooLarge: Status
    Definition Classes
    StatusCodes → StatusCodes
  34. def PaymentRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  35. def Post: Method
    Definition Classes
    Methods → Methods
  36. def PreconditionFailed: Status
    Definition Classes
    StatusCodes → StatusCodes
  37. def PreconditionRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  38. def ProxyAuthenticationRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  39. def Put: Method
    Definition Classes
    Methods → Methods
  40. def RangeNotSatisfiable: Status
    Definition Classes
    StatusCodes → StatusCodes
  41. def RequestHeaderFieldsTooLarge: Status
    Definition Classes
    StatusCodes → StatusCodes
  42. def RequestTimeout: Status
    Definition Classes
    StatusCodes → StatusCodes
  43. def ResetContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  44. def TooEarly: Status
    Definition Classes
    StatusCodes → StatusCodes
  45. def TooManyRequests: Status
    Definition Classes
    StatusCodes → StatusCodes
  46. def Unauthorized: Status
    Definition Classes
    StatusCodes → StatusCodes
  47. def UnavailableForLegalReasons: Status
    Definition Classes
    StatusCodes → StatusCodes
  48. def UnprocessableEntity: Status
    Definition Classes
    StatusCodes → StatusCodes
  49. def UnsupportedMediaType: Status
    Definition Classes
    StatusCodes → StatusCodes
  50. def UpgradeRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  51. def UriTooLong: Status
    Definition Classes
    StatusCodes → StatusCodes
  52. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  53. def assetSegments(name: String, docs: Documentation): Path[AssetPath]
    Definition Classes
    Assets → Assets
  54. def assetsEndpoint(url: Url[AssetPath], docs: Documentation, notFoundDocs: Documentation): Endpoint[AssetRequest, AssetResponse]
    Definition Classes
    Assets → Assets
  55. def assetsResources(blocker: Blocker, pathPrefix: Option[String] = None)(implicit cs: ContextShift[Effect]): (AssetRequest) => AssetResponse

    pathPrefix

    Prefix to use to look up the resources in the classpath (like '/assets'). 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.

  56. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  57. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  58. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  59. def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  60. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  61. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  62. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  63. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

    Concatenates two QueryStrings

    Concatenates two QueryStrings

    Definition Classes
    Urls → Urls
  64. 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
  65. def digests: Map[String, String]
    Definition Classes
    Assets → Assets
  66. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  67. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  68. def emptyRequest: RequestEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  69. def emptyRequestHeaders: RequestHeaders[Unit]

    HEADERS

    HEADERS

    Definition Classes
    EndpointsWithCustomErrors → Requests
  70. def emptyResponse: ResponseEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  71. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  72. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  73. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  74. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  75. def foundAssetResponse(content: Stream[Effect, Byte], contentLength: Long, fileName: String, isGzipped: Boolean, isExpired: Boolean, lastModifiedSeconds: Long): Found
  76. 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
  77. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  78. def handleClientErrors(invalid: Invalid): Effect[org.http4s.Response[Effect]]

    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
    EndpointsWithCustomErrors
  79. def handleServerError(throwable: Throwable): Effect[org.http4s.Response[Effect]]

    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
  80. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  81. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  82. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  83. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  84. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  85. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  86. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  87. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  88. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  89. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  90. 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
  91. def optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  92. def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  93. implicit 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 def 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 = None)(implicit value: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  100. implicit def queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  101. implicit def queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  102. def remainingSegments(name: String = "", docs: Documentation = None): Path[String]
    Definition Classes
    Urls → Urls
  103. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: 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] = emptyRequest, docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(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: Documentation): 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: Documentation = None): 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 lazy val responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  116. def routesFromEndpoints(endpoints: PartialFunction[org.http4s.Request[Effect], Effect[org.http4s.Response[Effect]]]*): PartialFunction[org.http4s.Request[Effect], Effect[org.http4s.Response[Effect]]]
    Definition Classes
    EndpointsWithCustomErrors
  117. def segment[A](name: String = "", docs: Documentation = None)(implicit A: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  118. implicit def segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  119. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  120. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  121. implicit def stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  122. implicit def stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  123. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  124. def textRequest: RequestEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  125. def textResponse: ResponseEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  126. def toString(): String
    Definition Classes
    AnyRef → Any
  127. implicit def urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  128. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

    Builds an URL from the given path and query string

    Builds an URL from the given path and query string

    Definition Classes
    Urls → Urls
  129. val utf8Name: String
    Definition Classes
    Urls
  130. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  131. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  132. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  133. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  134. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  135. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses
  136. object AssetResponse
  137. 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
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Urls

Inherited from StatusCodes

Inherited from Methods

Inherited from algebra.Assets

Inherited from Errors

Inherited from Responses

Inherited from algebra.StatusCodes

Inherited from Requests

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from AnyRef

Inherited from Any

Ungrouped