http4s

Type Members

1. final case class AttributeEntry[T](key: AttributeKey[T], value: T) extends Product with Serializable

   A map entry where key is constrained to only be associated with a fixed value of type T.

2. final class AttributeKey[T] extends AnyRef

   A key in an AttributeMap that constrains its associated value to be of type T.

3. final class AttributeMap extends AnyRef

   An immutable map where an AttributeKey for a fixed type T can only be associated with values of type T.

4. type AuthScheme = CaseInsensitiveString

5. case class AuthedRequest[A](authInfo: A, req: Request) extends Product with Serializable

6. type AuthedService[T] = Kleisli[Task, AuthedRequest[T], MaybeResponse]

7. final case class BasicCredentials(username: String, password: String) extends Credentials with Product with Serializable

8. sealed trait CacheDirective extends Product with Renderable

9. type Callback[A] = (\/[Throwable, A]) ⇒ Unit

10. final case class Challenge(scheme: String, realm: String, params: Map[String, String] = ...) extends Renderable with Product with Serializable

11. final case class Charset extends Renderable with Product with Serializable

12. sealed abstract class CharsetRange extends HasQValue with Renderable

13. trait CharsetRangeInstances extends AnyRef

14. final case class ContentCoding(coding: CaseInsensitiveString, qValue: QValue = QValue.One) extends HasQValue with Renderable with Product with Serializable

15. final case class Cookie(name: String, content: String, expires: Option[Instant] = scala.None, maxAge: Option[Long] = scala.None, domain: Option[String] = scala.None, path: Option[String] = scala.None, secure: Boolean = false, httpOnly: Boolean = false, extension: Option[String] = scala.None) extends Renderable with Product with Serializable

16. sealed abstract class Credentials extends Renderable

17. sealed abstract class DecodeFailure extends MessageFailure

    Indicates a problem decoding a Message.

18. type DecodeResult[T] = EitherT[Task, DecodeFailure, T]

19. type EntityBody = Process[Task, ByteVector]

20. trait EntityDecoder[T] extends AnyRef

    A type that can be used to decode a Message EntityDecoder is used to attempt to decode a Message returning the entire resulting A.

21. trait EntityDecoderInstances extends AnyRef

    Implementations of the EntityDecoder instances

22. trait EntityEncoder[A] extends AnyRef

    Annotations

    @implicitNotFound( ... )

23. trait EntityEncoderInstances extends EntityEncoderInstances0

24. trait EntityEncoderInstances0 extends AnyRef

25. type EventStream = Process[Task, ServerSentEvent]

    A stream of server-sent events

26. final case class GenericCredentials(authScheme: AuthScheme, params: Map[String, String]) extends Credentials with Product with Serializable

27. final case class GenericDecodeFailure(message: String, response: (HttpVersion) ⇒ Task[Response]) extends DecodeFailure with Product with Serializable

    Generic description of a failure to decode a Message

28. final case class GenericMessageBodyFailure(message: String, cause: Option[Throwable], response: (HttpVersion) ⇒ Task[Response]) extends MessageBodyFailure with Product with Serializable

    Generic description of a failure to handle a Message body

29. final case class GenericParsingFailure(sanitized: String, details: String, response: (HttpVersion) ⇒ Task[Response]) extends ParsingFailure with Product with Serializable

    Generic description of a failure to parse an HTTP Message

30. trait HasQValue extends AnyRef

31. sealed trait Header extends Renderable with Product

    Abstract representation o the HTTP header

32. sealed trait HeaderKey extends AnyRef

33. final class Headers extends Iterable[Header] with IterableLike[Header, Headers]

    A collection of HTTP Headers

34. trait Http4s extends Http4sInstances with Http4sFunctions with AllSyntax

35. trait Http4sFunctions extends QValueFunctions with UriFunctions

36. trait Http4sInstances extends EntityDecoderInstances with HttpVersionInstances with EntityEncoderInstances with CharsetRangeInstances with QValueInstances with MethodInstances with StatusInstances

37. final case class Http4sVersion(major: Int, minor: Int) extends Product with Serializable

38. type HttpService = Kleisli[Task, Request, MaybeResponse]

    A Service that produces a Task to compute a Response from a Request.

    A Service that produces a Task to compute a Response from a Request. An HttpService can be run on any supported http4s server backend, such as Blaze, Jetty, or Tomcat.

39. final case class HttpVersion extends Renderable with Ordered[HttpVersion] with Product with Serializable

    An HTTP version, as seen on the start line of an HTTP request or response.

40. trait HttpVersionInstances extends AnyRef

41. final case class InvalidBodyException(msg: String) extends Exception with NoStackTrace with Product with Serializable

    Exception dealing with invalid body

42. sealed case class InvalidMessageBodyFailure(details: String, cause: Option[Throwable] = scala.None) extends MessageBodyFailure with Product with Serializable

    Indicates a semantic error decoding the body of an HTTP Message.

43. final case class InvalidResponseException(msg: String) extends Exception with NoStackTrace with Product with Serializable

    Exception dealing with invalid response

44. final case class LanguageTag(primaryTag: String, q: QValue = QValue.One, subTags: Seq[String] = immutable.this.Nil) extends Renderable with Product with Serializable

45. sealed case class MalformedMessageBodyFailure(details: String, cause: Option[Throwable] = scala.None) extends MessageBodyFailure with Product with Serializable

    Indicates an syntactic error decoding the body of an HTTP Message.

46. sealed trait MaybeResponse extends AnyRef

    Represents that a service either returns a Response or a Pass to fall through to another service.

47. sealed class MediaRange extends Renderable

48. sealed class MediaType extends MediaRange

49. final case class MediaTypeMismatch(messageType: MediaType, expected: Set[MediaRange]) extends UnsupportedMediaTypeFailure with Product with Serializable

    Indicates that no EntityDecoder matches the MediaType of the Message being decoded

50. final case class MediaTypeMissing(expected: Set[MediaRange]) extends UnsupportedMediaTypeFailure with Product with Serializable

    Indicates that a Message attempting to be decoded has no MediaType and no EntityDecoder was lenient enough to accept it.

51. sealed trait Message extends MessageOps

    Represents a HTTP Message.

52. sealed abstract class MessageBodyFailure extends DecodeFailure

    Indicates a problem decoding a Message body.

53. sealed abstract class MessageFailure extends RuntimeException

    Indicates a failure to handle an HTTP Message.

54. trait MessageOps extends Any

55. trait MessageSyntax extends AnyRef

56. sealed abstract case class Method extends Renderable with Semantics with Product with Serializable

    An HTTP method.

57. trait MethodInstances extends AnyRef

58. final case class OAuth2BearerToken(token: String) extends Credentials with Product with Serializable

59. final case class ParseFailure(sanitized: String, details: String) extends ParsingFailure with Product with Serializable

    Indicates an error parsing an HTTP Message.

60. type ParseResult[+A] = \/[ParseFailure, A]

61. sealed abstract class ParsingFailure extends MessageFailure with NoStackTrace

    Indicates an error parsing an HTTP Message.

62. final class QValue extends AnyVal with Ordered[QValue] with Renderable

    A Quality Value.

63. trait QValueFunctions extends AnyRef

64. trait QValueInstances extends AnyRef

65. final class Query extends IndexedSeq[(String, Option[String])] with IndexedSeqOptimized[(String, Option[String]), Query] with QueryOps with Renderable

    Collection representation of a query string

66. trait QueryOps extends AnyRef

67. trait QueryParam[T] extends AnyRef

    type class defining the key of a query parameter Usually used in conjunction with QueryParamEncoder and QueryParamDecoder

68. trait QueryParamDecoder[T] extends AnyRef

    Type class defining how to decode a QueryParameterValue into a T

69. trait QueryParamEncoder[T] extends AnyRef

    Type class defining how to encode a T as a QueryParameterValues

70. trait QueryParamKeyLike[T] extends AnyRef

71. final case class QueryParameterKey(value: String) extends AnyVal with Product with Serializable

72. final case class QueryParameterValue(value: String) extends AnyVal with Product with Serializable

73. final case class RangeUnit(value: String) extends Renderable with Product with Serializable

74. final case class Request(method: Method = Method.GET, uri: Uri = ..., httpVersion: HttpVersion = HttpVersion.HTTP/1.1, headers: Headers = Headers.empty, body: EntityBody = http4s.this.`package`.EmptyBody, attributes: AttributeMap = AttributeMap.empty) extends Message with RequestOps with Product with Serializable

    Representation of an incoming HTTP message

75. class RequestCookieJar extends Iterable[Cookie] with IterableLike[Cookie, RequestCookieJar]

76. trait RequestOps extends MessageOps

77. final case class Response(status: Status = Status.Ok, httpVersion: HttpVersion = HttpVersion.HTTP/1.1, headers: Headers = Headers.empty, body: EntityBody = http4s.this.`package`.EmptyBody, attributes: AttributeMap = AttributeMap.empty) extends Message with MaybeResponse with ResponseOps with Product with Serializable

    Representation of the HTTP response to send back to the client

78. trait ResponseOps extends MessageOps

79. case class ServerSentEvent(data: String, eventType: Option[String] = scala.None, id: Option[EventId] = scala.None, retry: Option[Long] = scala.None) extends Renderable with Product with Serializable

80. type Service[A, B] = Kleisli[Task, A, B]

    A Service wraps a function of request type A to a Task that runs to response type B.

    A Service wraps a function of request type A to a Task that runs to response type B. By wrapping the Service, we can compose them using Kleisli operations.

81. final case class Status extends Ordered[Status] with Renderable with Product with Serializable

    Representation of the HTTP response code and reason

82. trait StatusInstances extends AnyRef

83. final case class TransferCoding extends Renderable with Product with Serializable

84. sealed abstract class UnsupportedMediaTypeFailure extends DecodeFailure with NoStackTrace

    Indicates that a Message came with no supported MediaType.

85. final case class Uri(scheme: Option[CaseInsensitiveString] = scala.None, authority: Option[Authority] = scala.None, path: Path = "", query: Query = Query.empty, fragment: Option[Fragment] = scala.None) extends QueryOps with Renderable with Product with Serializable

    Representation of the Request URI

86. trait UriFunctions extends AnyRef

87. final case class UriTemplate(scheme: Option[Scheme] = scala.None, authority: Option[Authority] = scala.None, path: Path = immutable.this.Nil, query: UriTemplate.Query = immutable.this.Nil, fragment: Fragment = immutable.this.Nil) extends Product with Serializable

    Simple representation of a URI Template that can be rendered as RFC6570 conform string.

88. final class UrlForm extends AnyVal

89. type Http4sSyntax = AllSyntax

    Annotations

    @deprecated

    Deprecated

    (Since version 0.16) Moved to org.http4s.syntax.AllSyntax