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.

   A key in an AttributeMap that constrains its associated value to be of type T. The key is uniquely defined by its reference: there are no duplicate keys, even those with the same name and type.

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.

   An immutable map where an AttributeKey for a fixed type T can only be associated with values of type T. Because the equality of keys is based on reference, it is therefore possible for this map to contain mappings for keys with the same label and same types.

4. type AuthScheme = CaseInsensitiveString

   

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

   

6. sealed trait CacheDirective extends Product with Renderable

   

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

   

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

   

9. sealed abstract class CharsetRange extends HasQValue with Renderable

   

10. trait CharsetRangeInstances extends AnyRef

    

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

    

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

    

13. sealed abstract class Credentials extends Renderable

    

14. sealed trait DecodeFailure extends AnyRef

    

15. final case class DecodeFailureException(failure: DecodeFailure) extends RuntimeException with Product with Serializable

    

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

    

17. type EntityBody = Process[Task, ByteVector]

    

18. 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.

    A type that can be used to decode a Message EntityDecoder is used to attempt to decode a Message returning the entire resulting A. If an error occurs it will result in a failed Task The default decoders provided here are not streaming, but one could implement a streaming decoder by having the value of A be some kind of streaming construct.

    T

    result type produced by the decoder

19. trait EntityDecoderInstances extends AnyRef

    

    Implementations of the EntityDecoder instances

20. trait EntityEncoder[A] extends AnyRef

    

21. trait EntityEncoderInstances extends EntityEncoderInstances0

    

22. trait EntityEncoderInstances0 extends AnyRef

    

23. trait Fallthrough[B] extends AnyRef

    

    Encapsulates the notion of fallthrough orElse for a Service For any given B, if a Fallthrough[B] exists within implicit context then Service#orElse can be used.

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

    

25. trait HasQValue extends AnyRef

    

26. sealed trait Header extends Renderable with Product

    

    Abstract representation o the HTTP header

    Abstract representation o the HTTP header

    See also

    org.http4s.HeaderKey

27. sealed trait HeaderKey extends AnyRef

    

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

    

    A collection of HTTP Headers

29. trait Http4s extends Http4sInstances with Http4sFunctions with Http4sSyntax

    

30. trait Http4sFunctions extends QValueFunctions with UriFunctions

    

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

    

32. trait Http4sSyntax extends CaseInsensitiveStringSyntax with MessageSyntax

    

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

    

34. type HttpService = Kleisli[Task, Request, Response]

    

    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.

35. 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.

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

    See also

    [http://tools.ietf.org/html/rfc7230#section-2.6 RFC 7320, Section 2.6

36. trait HttpVersionInstances extends AnyRef

    

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

    

    Exception dealing with invalid body

    Exception dealing with invalid body

    msg

    description if what makes the body invalid

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

    

    Exception dealing with invalid response

    Exception dealing with invalid response

    msg

    description if what makes the response invalid

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

    

40. sealed class MediaRange extends HasQValue with Renderable

    

41. sealed class MediaType extends MediaRange

    

42. case class MediaTypeMismatch(messageType: MediaType, expected: Set[MediaRange]) extends DecodeFailure with Product with Serializable

    

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

43. case class MediaTypeMissing(expected: Set[MediaRange]) extends DecodeFailure with Product with Serializable

    

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

44. sealed trait Message extends MessageOps

    

    Represents a HTTP Message.

    Represents a HTTP Message. The interesting subclasses are Request and Response while most of the functionality is found in MessageSyntax and ResponseOps

    See also

    MessageSyntax, ResponseOps

45. trait MessageOps extends Any

    

46. trait MessageSyntax extends AnyRef

    

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

    

    An HTTP method.

    An HTTP method.

    See also

    [http://www.iana.org/assignments/http-methods/http-methods.xhtml IANA HTTP Method Registry]

    [http://tools.ietf.org/html/rfc7231#section-4 RFC7321, Section 4]

48. trait MethodInstances extends AnyRef

    

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

    

50. final case class ParseException(failure: ParseFailure) extends RuntimeException with Product with Serializable

    

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

    

    Indicates an error parsing an HTTP message.

    Indicates an error parsing an HTTP message.

    sanitized

    May safely be displayed to a client to describe an error condition. Should not echo any part of a Request.

    details

    Contains any relevant details omitted from the sanitized version of the error. This may freely echo a Request.

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

    

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

    

    A Quality Value.

    A Quality Value. Represented as thousandths for an exact representation rounded to three decimal places.

    See also

    RFC 2616, Section 3.9

54. trait QValueFunctions extends AnyRef

    

55. trait QValueInstances extends AnyRef

    

56. final class Query extends IndexedSeq[KeyValue] with IndexedSeqOptimized[KeyValue, Query] with QueryOps with Renderable

    

    Collection representation of a query string

    Collection representation of a query string

    It is a indexed sequence of key and maybe a value pairs which maps precisely to a query string, modulo the identity of separators.

    When rendered, the resulting String will have the pairs separated by '&' while the key is separated from the value with '='

57. trait QueryOps extends AnyRef

    

58. trait QueryParam[T] extends AnyRef

    

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

59. trait QueryParamDecoder[T] extends AnyRef

    

    Type class defining how to decode a QueryParameterValue into a T

    Type class defining how to decode a QueryParameterValue into a T

    See also

    QueryParamCodecLaws

60. trait QueryParamEncoder[T] extends AnyRef

    

    Type class defining how to encode a T as a QueryParameterValues

    Type class defining how to encode a T as a QueryParameterValues

    See also

    QueryParamCodecLaws

61. trait QueryParamKeyLike[T] extends AnyRef

    

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

    

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

    

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

    

65. case class Request(method: Method = Method.GET, uri: Uri = Uri(path = "/"), httpVersion: HttpVersion = HttpVersion.`HTTP/1.1`, headers: Headers = Headers.empty, body: EntityBody = EmptyBody, attributes: AttributeMap = AttributeMap.empty) extends Message with MessageOps with Product with Serializable

    

    Representation of an incoming HTTP message

    Representation of an incoming HTTP message

    A Request encapsulates the entirety of the incoming HTTP request including the status line, headers, and a possible request body.

    method

    Method.GET, Method.POST, etc.

    uri

    representation of the request URI

    httpVersion

    the HTTP version

    headers

    collection of Headers

    body

    scalaz.stream.Process[Task,Chunk] defining the body of the request

    attributes

    Immutable Map used for carrying additional information in a type safe fashion

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

    

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

    

    Representation of the HTTP response to send back to the client

    Representation of the HTTP response to send back to the client

    status

    Status code and message

    headers

    Headers containing all response headers

    body

    scalaz.stream.Process[Task,Chunk] representing the possible body of the response

    attributes

    AttributeMap containing additional parameters which may be used by the http4s backend for additional processing such as java.io.File object

68. trait ResponseOps extends MessageOps

    

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

    

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

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

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

    

    Representation of the HTTP response code and reason

    Representation of the HTTP response code and reason

    Note: the reason is not important to the protocol and is not considered in equality checks.

    See also

    [http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml IANA Status Code Registry]

    [http://tools.ietf.org/html/rfc7231#section-6 RFC7231, Section 6]

71. trait StatusInstances extends AnyRef

    

72. trait TaskMessageOps[M <: Message] extends MessageOps

    

73. final class TaskRequestOps extends AnyVal with TaskMessageOps[Request]

    

74. final class TaskResponseOps extends AnyVal with TaskMessageOps[Response] with ResponseOps

    

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

    

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

    

    Representation of the Request URI Structure containing information related to a Uri.

    Representation of the Request URI Structure containing information related to a Uri. All fields except the query are expected to be url decoded.

    scheme

    optional Uri Scheme. eg, http, https

    authority

    optional Uri Authority. eg, localhost:8080, www.foo.bar

    path

    the Uri path

    query

    optional Query. Note that the query should _NOT_ be url decoded

    fragment

    optional Uri Fragment. Note that the fragment should _NOT_ be url decoded

77. trait UriFunctions extends AnyRef

    

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

    

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

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

    This model reflects only a subset of RFC6570.

    Level 1 and Level 2 are completely modeled and Level 3 features are limited to:

    • Path segments, slash-prefixed
    • Form-style query, ampersand-separated
    • Fragment expansion

79. final class UrlForm extends AnyVal