Packages

package dsl

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. dsl
  2. Http4s
  3. AllSyntax
  4. TaskRequestSyntax
  5. TaskResponseSyntax
  6. StringSyntax
  7. ServiceSyntax
  8. Http4sFunctions
  9. UriFunctions
  10. QValueFunctions
  11. Http4sInstances
  12. StatusInstances
  13. MethodInstances
  14. QValueInstances
  15. CharsetRangeInstances
  16. EntityEncoderInstances
  17. EntityEncoderInstances0
  18. HttpVersionInstances
  19. EntityDecoderInstances
  20. AnyRef
  21. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final case class / (parent: Path, child: String) extends Path with Product with Serializable
  2. implicit final class AcceptedSyntax extends AnyVal with EntityResponseGenerator
  3. implicit final class AlreadyReportedSyntax extends AnyVal with EntityResponseGenerator
  4. implicit final class BadGatewaySyntax extends AnyVal with EntityResponseGenerator
  5. implicit final class BadRequestSyntax extends AnyVal with EntityResponseGenerator
  6. implicit final class ConflictSyntax extends AnyVal with EntityResponseGenerator
  7. implicit final class ContinueSyntax extends AnyVal with EmptyResponseGenerator
  8. implicit final class CreatedSyntax extends AnyVal with EntityResponseGenerator
  9. implicit final class ExpectationFailedSyntax extends AnyVal with EntityResponseGenerator
  10. implicit final class FailedDependencySyntax extends AnyVal with EntityResponseGenerator
  11. implicit final class ForbiddenSyntax extends AnyVal with EntityResponseGenerator
  12. implicit final class FoundSyntax extends AnyVal with LocationResponseGenerator
  13. implicit final class GatewayTimeoutSyntax extends AnyVal with EntityResponseGenerator
  14. implicit final class GoneSyntax extends AnyVal with EntityResponseGenerator
  15. implicit final class HttpVersionNotSupportedSyntax extends AnyVal with EntityResponseGenerator
  16. implicit final class IMUsedSyntax extends AnyVal with EntityResponseGenerator
  17. implicit final class InsufficientStorageSyntax extends AnyVal with EntityResponseGenerator
  18. implicit final class InternalServerErrorSyntax extends AnyVal with EntityResponseGenerator
  19. implicit final class LengthRequiredSyntax extends AnyVal with EntityResponseGenerator
  20. implicit final class LockedSyntax extends AnyVal with EntityResponseGenerator
  21. implicit final class LoopDetectedSyntax extends AnyVal with EntityResponseGenerator
  22. class MethodConcat extends AnyRef
  23. implicit final class MethodConcatOps extends AnyVal
  24. implicit final class MethodNotAllowedSyntax extends AnyVal with EntityResponseGenerator
  25. implicit final class MethodOps extends AnyVal
  26. implicit final class MovedPermanentlySyntax extends AnyVal with LocationResponseGenerator
  27. implicit final class MultipleChoicesSyntax extends AnyVal with LocationResponseGenerator
  28. implicit final class Multiyntax extends AnyVal with EntityResponseGenerator
  29. implicit final class NetworkAuthenticationRequiredSyntax extends AnyVal with EntityResponseGenerator
  30. implicit final class NoContentSyntax extends AnyVal with EmptyResponseGenerator
  31. implicit final class NonAuthoritativeInformationSyntax extends AnyVal with EntityResponseGenerator
  32. implicit final class NotAcceptableSyntax extends AnyVal with EntityResponseGenerator
  33. implicit final class NotExtendedSyntax extends AnyVal with EntityResponseGenerator
  34. implicit final class NotFoundSyntax extends AnyVal with EntityResponseGenerator
  35. implicit final class NotImplementedSyntax extends AnyVal with EntityResponseGenerator
  36. implicit final class NotModifiedSyntax extends AnyVal with EmptyResponseGenerator
  37. class NumericPathVar [A <: AnyVal] extends AnyRef
    Attributes
    protected
  38. implicit final class OkSyntax extends AnyVal with EntityResponseGenerator
  39. abstract class OptionalMultiQueryParamDecoderMatcher [T] extends AnyRef

    Capture a query parameter that appears 0 or more times.

    Capture a query parameter that appears 0 or more times.

    case class Foo(i: Int)
    implicit val fooDecoder: QueryParamDecoder[Foo] = ...
    implicit val fooParam: QueryParam[Foo] = ...
    
    object FooMatcher extends OptionalMultiQueryParamDecoderMatcher[Foo]("foo")
    val service: HttpService = {
      // matches http://.../closest?foo=2&foo=3&foo=4
      case GET -> Root / "closest" :? FooMatcher(Some(Seq(2,3,4))) => ...
    
      /*
      *  matches http://.../closest?foo=2&foo=3&foo=4 as well as http://.../closest (no parameters)
      *  or http://.../closest?foo=2 (single occurrence)
      */
      case GET -> Root / "closest" :? FooMatcher(is) => ...
  40. abstract class OptionalQueryParamDecoderMatcher [T] extends AnyRef
  41. abstract class OptionalQueryParamMatcher [T] extends OptionalQueryParamDecoderMatcher[T]
  42. abstract class OptionalValidatingQueryParamDecoderMatcher [T] extends AnyRef

    param extractor using org.http4s.QueryParamDecoder.

    param extractor using org.http4s.QueryParamDecoder. Note that this will _always_ match, but will return an Option possibly containing the result of the conversion to T

    case class Foo(i: Int)
    implicit val fooDecoder: QueryParamDecoder[Foo] = ...
    
    case class Bar(i: Int)
    implicit val barDecoder: QueryParamDecoder[Bar] = ...
    
    object FooMatcher extends ValidatingQueryParamDecoderMatcher[Foo]("foo")
    object BarMatcher extends OptionalValidatingQueryParamDecoderMatcher[Bar]("bar")
    
    val service: HttpService = {
    case GET -> Root / "closest" :? FooMatcher(fooValue) +& BarMatcher(barValue) => {
      ^(fooValue, barValue getOrElse 42.right) { (foo, bar) =>
        ...
      }.fold(
        nelE => BadRequest(nelE.toList.map(_.sanitized).mkString("\n")),
        baz  => { ... }
      )
    }
  43. implicit final class PartialContentSyntax extends AnyVal with EntityResponseGenerator
  44. abstract class Path extends AnyRef

    Base class for path extractors.

  45. implicit final class PayloadTooLargeSyntax extends AnyVal with EntityResponseGenerator
  46. implicit final class PaymentRequiredSyntax extends AnyVal with EntityResponseGenerator
  47. implicit final class PermanentRedirectSyntax extends AnyVal with LocationResponseGenerator
  48. implicit final class PreconditionFailedSyntax extends AnyVal with EntityResponseGenerator
  49. implicit final class PreconditionRequiredSyntax extends AnyVal with EntityResponseGenerator
  50. implicit final class ProxyAuthenticationRequiredSyntax extends AnyVal with EntityResponseGenerator
  51. abstract class QueryParamDecoderMatcher [T] extends AnyRef

    param extractor using QueryParamDecoder:

    param extractor using QueryParamDecoder:

    case class Foo(i: Int)
    implicit val fooDecoder: QueryParamDecoder[Foo] = ...
    
    object FooMatcher extends QueryParamDecoderMatcher[Foo]("foo")
    val service: HttpService = {
      case GET -> Root / "closest" :? FooMatcher(2) => ...
  52. abstract class QueryParamMatcher [T] extends QueryParamDecoderMatcher[T]

    param extractor using QueryParamDecoder:

    param extractor using QueryParamDecoder:

    case class Foo(i: Int)
    implicit val fooDecoder: QueryParamDecoder[Foo] = ...
    implicit val fooParam: QueryParam[Foo] = ...
    
    object FooMatcher extends QueryParamDecoderMatcher[Foo]
    val service: HttpService = {
      case GET -> Root / "closest" :? FooMatcher(2) => ...
  53. implicit final class RangeNotSatisfiableSyntax extends AnyVal with EntityResponseGenerator
  54. implicit final class RequestHeaderFieldsTooLargeSyntax extends AnyVal with EntityResponseGenerator
  55. implicit final class RequestTimeoutSyntax extends AnyVal with EntityResponseGenerator
  56. implicit final class ResetContentSyntax extends AnyVal with EmptyResponseGenerator
  57. implicit final class SeeOtherSyntax extends AnyVal with LocationResponseGenerator
  58. implicit final class ServiceUnavailableSyntax extends AnyVal with EntityResponseGenerator
  59. implicit final class SwitchingProtocolsSyntax extends AnyVal with EmptyResponseGenerator
  60. implicit final class TemporaryRedirectSyntax extends AnyVal with LocationResponseGenerator
  61. implicit final class TooManyRequestsSyntax extends AnyVal with EntityResponseGenerator
  62. implicit final class UnauthorizedSyntax extends AnyVal with WwwAuthenticateResponseGenerator
  63. implicit final class UnavailableForLegalReasonsSyntax extends AnyVal with EntityResponseGenerator
  64. implicit final class UnprocessableEntitySyntax extends AnyVal with EntityResponseGenerator
  65. implicit final class UnsupportedMediaTypeSyntax extends AnyVal with EntityResponseGenerator
  66. implicit final class UpgradeRequiredSyntax extends AnyVal with EntityResponseGenerator
  67. implicit final class UriTooLongSyntax extends AnyVal with EntityResponseGenerator
  68. abstract class ValidatingQueryParamDecoderMatcher [T] extends AnyRef

    param extractor using org.http4s.QueryParamDecoder.

    param extractor using org.http4s.QueryParamDecoder. Note that this will return a ParseFailure if the parameter cannot be decoded.

    case class Foo(i: Int)
    implicit val fooDecoder: QueryParamDecoder[Foo] = ...
    
    object FooMatcher extends ValidatingQueryParamDecoderMatcher[Foo]("foo")
    val service: HttpService = {
    case GET -> Root / "closest" :? FooMatcher(fooValue) => {
      fooValue.fold(
        nelE => BadRequest(nelE.toList.map(_.sanitized).mkString("\n")),
        foo  => { ... }
      )
    }
  69. implicit final class VariantAlsoNegotiatesSyntax extends AnyVal with EntityResponseGenerator

Value Members

  1. val Accepted: Status.Accepted.type
  2. val AlreadyReported: Status.AlreadyReported.type
  3. val BadGateway: Status.BadGateway.type
  4. val BadRequest: Status.BadRequest.type
  5. val CONNECT: Method.CONNECT
  6. implicit val CharacterSetEqual: Equal[CharsetRange]
    Definition Classes
    CharsetRangeInstances
  7. implicit val CharsetShow: Show[Charset]
    Definition Classes
    CharsetRangeInstances
  8. val Conflict: Status.Conflict.type
  9. val Continue: Status.Continue.type
  10. val Created: Status.Created.type
  11. val DELETE: Method.DELETE
  12. val ExpectationFailed: Status.ExpectationFailed.type
  13. val FailedDependency: Status.FailedDependency.type
  14. val Forbidden: Status.Forbidden.type
  15. val Found: Status.Found.type
  16. val GET: Method.GET
  17. val GatewayTimeout: Status.GatewayTimeout.type
  18. val Gone: Status.Gone.type
  19. val HEAD: Method.HEAD
  20. val HttpVersionNotSupported: Status.HttpVersionNotSupported.type
  21. implicit val HttpVersionOrder: Order[HttpVersion]
    Definition Classes
    HttpVersionInstances
  22. implicit val HttpVersionShow: Show[HttpVersion]
    Definition Classes
    HttpVersionInstances
  23. val IMUsed: Status.IMUsed.type
  24. val InsufficientStorage: Status.InsufficientStorage.type
  25. val InternalServerError: Status.InternalServerError.type
  26. val LengthRequired: Status.LengthRequired.type
  27. val Locked: Status.Locked.type
  28. val LoopDetected: Status.LoopDetected.type
  29. implicit val MethodInstances: Show[Method] with Equal[Method]
    Definition Classes
    MethodInstances
  30. val MethodNotAllowed: Status.MethodNotAllowed.type
  31. val MovedPermanently: Status.MovedPermanently.type
  32. val MultiStatus: Status.MultiStatus.type
  33. val MultipleChoices: Status.MultipleChoices.type
  34. val NetworkAuthenticationRequired: Status.NetworkAuthenticationRequired.type
  35. val NoContent: Status.NoContent.type
  36. val NonAuthoritativeInformation: Status.NonAuthoritativeInformation.type
  37. val NotAcceptable: Status.NotAcceptable.type
  38. val NotExtended: Status.NotExtended.type
  39. val NotFound: Status.NotFound.type
  40. val NotImplemented: Status.NotImplemented.type
  41. val NotModified: Status.NotModified.type
  42. val OPTIONS: Method.OPTIONS
  43. val Ok: Status.Ok.type
  44. val PATCH: Method.PATCH
  45. val POST: Method.POST
  46. val PUT: Method.PUT
  47. val PartialContent: Status.PartialContent.type
  48. val PayloadTooLarge: Status.PayloadTooLarge.type
  49. val PaymentRequired: Status.PaymentRequired.type
  50. val PermanentRedirect: Status.PermanentRedirect.type
  51. val PreconditionFailed: Status.PreconditionFailed.type
  52. val PreconditionRequired: Status.PreconditionRequired.type
  53. val Processing: Status.Processing.type
  54. val ProxyAuthenticationRequired: Status.ProxyAuthenticationRequired.type
  55. val RangeNotSatisfiable: Status.RangeNotSatisfiable.type
  56. val RequestHeaderFieldsTooLarge: Status.RequestHeaderFieldsTooLarge.type
  57. val RequestTimeout: Status.RequestTimeout.type
  58. val ResetContent: Status.ResetContent.type
  59. val SeeOther: Status.SeeOther.type
  60. val ServiceUnavailable: Status.ServiceUnavailable.type
  61. implicit val StatusOrder: Order[Status]
    Definition Classes
    StatusInstances
  62. implicit val StatusShow: Show[Status]
    Definition Classes
    StatusInstances
  63. val SwitchingProtocols: Status.SwitchingProtocols.type
  64. val TRACE: Method.TRACE
  65. val TemporaryRedirect: Status.TemporaryRedirect.type
  66. val TooManyRequests: Status.TooManyRequests.type
  67. val Unauthorized: Status.Unauthorized.type
  68. val UnavailableForLegalReasons: Status.UnavailableForLegalReasons.type
  69. val UnprocessableEntity: Status.UnprocessableEntity.type
  70. val UnsupportedMediaType: Status.UnsupportedMediaType.type
  71. val UpgradeRequired: Status.UpgradeRequired.type
  72. val UriTooLong: Status.UriTooLong.type
  73. val UseProxy: Status.UseProxy.type
  74. val VariantAlsoNegotiates: Status.VariantAlsoNegotiates.type
  75. def binFile(file: File): EntityDecoder[File]
    Definition Classes
    EntityDecoderInstances
  76. implicit val binary: EntityDecoder[ByteVector]
    Definition Classes
    EntityDecoderInstances
  77. implicit val byteArrayEncoder: EntityEncoder[Array[Byte]]
    Definition Classes
    EntityEncoderInstances
  78. implicit val byteVectorEncoder: EntityEncoder[ByteVector]
    Definition Classes
    EntityEncoderInstances
  79. implicit def charArrayEncoder(implicit charset: Charset = DefaultCharset): EntityEncoder[Array[Char]]
    Definition Classes
    EntityEncoderInstances
  80. def chunkedEncoder[A](f: (A) ⇒ Channel[Task, Int, ByteVector], chunkSize: Int = DefaultChunkSize): EntityEncoder[A]
    Definition Classes
    EntityEncoderInstances
  81. def emptyEncoder[A]: EntityEncoder[A]
    Definition Classes
    EntityEncoderInstances0
  82. implicit val entityEncoderContravariant: Contravariant[EntityEncoder]
    Definition Classes
    EntityEncoderInstances
  83. def error[T](t: Throwable): EntityDecoder[T]

    Provides a mechanism to fail decoding

    Provides a mechanism to fail decoding

    Definition Classes
    EntityDecoderInstances
  84. implicit val fileEncoder: EntityEncoder[File]
    Definition Classes
    EntityEncoderInstances
  85. implicit val filePathEncoder: EntityEncoder[java.nio.file.Path]
    Definition Classes
    EntityEncoderInstances
  86. implicit def futureEncoder[A](implicit W: EntityEncoder[A], ec: ExecutionContext): EntityEncoder[Future[A]]
    Definition Classes
    EntityEncoderInstances0
  87. implicit def http4sServiceSyntax[A](service: Service[A, MaybeResponse]): ServiceOps[A]
    Definition Classes
    ServiceSyntax
  88. implicit def http4sStringSyntax(s: String): StringOps
    Definition Classes
    StringSyntax
  89. implicit def http4sTaskRequestSyntax(req: Task[Request]): TaskRequestOps
    Definition Classes
    TaskRequestSyntax
  90. implicit def http4sTaskResponseSyntax(resp: Task[Response]): TaskResponseOps
    Definition Classes
    TaskResponseSyntax
  91. implicit def inputStreamEncoder[A <: InputStream]: EntityEncoder[A]
    Definition Classes
    EntityEncoderInstances
  92. implicit def multipart: EntityDecoder[Multipart]
    Definition Classes
    EntityDecoderInstances
  93. implicit val multipartEncoder: EntityEncoder[Multipart]
    Definition Classes
    EntityEncoderInstances
  94. implicit def naturalTransformationEncoder[F[_], A](implicit N: ~>[F, Task], W: EntityEncoder[A]): EntityEncoder[F[A]]
    Definition Classes
    EntityEncoderInstances0
  95. implicit def process0Encoder[A](implicit W: EntityEncoder[A]): EntityEncoder[Process0[A]]
    Definition Classes
    EntityEncoderInstances0
  96. macro def q(d: Double): QValue

    Supports a literal syntax for validated QValues.

    Supports a literal syntax for validated QValues.

    Example:

    q(0.5).success == QValue.fromDouble(0.5)
    q(1.1) // does not compile: out of range
    val d = 0.5
    q(d) // does not compile: not a literal
    Definition Classes
    QValueFunctions
  97. implicit val qValueOrder: Order[QValue]
    Definition Classes
    QValueInstances
  98. implicit val qValueShow: Show[QValue]
    Definition Classes
    QValueInstances
  99. implicit def readerEncoder[A <: Reader](implicit charset: Charset = DefaultCharset): EntityEncoder[A]
    Definition Classes
    EntityEncoderInstances
  100. def removeDotSegments(path: Uri.Path): Uri.Path

    Remove dot sequences from a Path, per RFC 3986 Sec 5.2.4

    Remove dot sequences from a Path, per RFC 3986 Sec 5.2.4

    Definition Classes
    UriFunctions
  101. def resolve(base: Uri, reference: Uri): Uri

    Resolve a relative Uri reference, per RFC 3986 sec 5.2

    Resolve a relative Uri reference, per RFC 3986 sec 5.2

    Definition Classes
    UriFunctions
  102. implicit val serverSentEventEncoder: EntityEncoder[EventStream]
    Definition Classes
    EntityEncoderInstances
  103. def showEncoder[A](implicit charset: Charset = DefaultCharset, show: Show[A]): EntityEncoder[A]

    Encodes a value from its Show instance.

    Encodes a value from its Show instance. Too broad to be implicit, too useful to not exist.

    Definition Classes
    EntityEncoderInstances0
  104. implicit def sourceEncoder[A](implicit W: EntityEncoder[A]): EntityEncoder[Process[Task, A]]

    A process encoder is intended for streaming, and does not calculate its bodies in advance.

    A process encoder is intended for streaming, and does not calculate its bodies in advance. As such, it does not calculate the Content-Length in advance. This is for use with chunked transfer encoding.

    Definition Classes
    EntityEncoderInstances0
  105. implicit def stringEncoder(implicit charset: Charset = DefaultCharset): EntityEncoder[String]
    Definition Classes
    EntityEncoderInstances
  106. implicit def taskEncoder[A](implicit W: EntityEncoder[A]): EntityEncoder[Task[A]]
    Definition Classes
    EntityEncoderInstances
  107. implicit def text(implicit defaultCharset: Charset = DefaultCharset): EntityDecoder[String]
    Definition Classes
    EntityDecoderInstances
  108. def textFile(file: File): EntityDecoder[File]
    Definition Classes
    EntityDecoderInstances
  109. implicit val unitEncoder: EntityEncoder[Unit]
    Definition Classes
    EntityEncoderInstances
  110. macro def uri(s: String): Uri

    Literal syntax for URIs.

    Literal syntax for URIs. Invalid or non-literal arguments are rejected at compile time.

    Definition Classes
    UriFunctions
  111. implicit val void: EntityDecoder[Unit]

    An entity decoder that ignores the content and returns unit.

    An entity decoder that ignores the content and returns unit.

    Definition Classes
    EntityDecoderInstances
  112. object +&

    Multiple param extractor:

    Multiple param extractor:

    object A extends QueryParamDecoderMatcher[String]("a")
    object B extends QueryParamDecoderMatcher[Int]("b")
    val service: HttpService = {
      case GET -> Root / "user" :? A(a) +& B(b) => ...
  113. object ->
  114. object /:

    Path separator extractor:

    Path separator extractor:

    Path("/1/2/3/test.json") match {
      case "1" /: "2" /: _ =>  ...
  115. object :?
  116. object IntVar extends NumericPathVar[Int]

    Integer extractor of a path variable:

    Integer extractor of a path variable:

    Path("/user/123") match {
       case Root / "user" / IntVar(userId) => ...
  117. object LongVar extends NumericPathVar[Long]

    Long extractor of a path variable:

    Long extractor of a path variable:

    Path("/user/123") match {
       case Root / "user" / LongVar(userId) => ...
  118. object Path
  119. object Root extends Path with Product with Serializable

    Root extractor:

    Root extractor:

    Path("/") match {
      case Root => ...
    }
  120. object as
  121. object ~

    File extension extractor

Deprecated Value Members

  1. implicit val byteBufferEncoder: EntityEncoder[ByteBuffer]
    Definition Classes
    EntityEncoderInstances
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Removed due to unpredictable semantics. Wrap in a ByteVector first.

  2. implicit def charBufferEncoder(implicit charset: Charset = DefaultCharset): EntityEncoder[CharBuffer]
    Definition Classes
    EntityEncoderInstances
    Annotations
    @deprecated
    Deprecated

    (Since version 0.16) Removed due to unpredictable semantics. Convert to a String first.

Inherited from Http4s

Inherited from AllSyntax

Inherited from TaskRequestSyntax

Inherited from TaskResponseSyntax

Inherited from StringSyntax

Inherited from ServiceSyntax

Inherited from Http4sFunctions

Inherited from UriFunctions

Inherited from QValueFunctions

Inherited from Http4sInstances

Inherited from StatusInstances

Inherited from MethodInstances

Inherited from QValueInstances

Inherited from CharsetRangeInstances

Inherited from EntityEncoderInstances

Inherited from EntityEncoderInstances0

Inherited from HttpVersionInstances

Inherited from EntityDecoderInstances

Inherited from AnyRef

Inherited from Any

Ungrouped