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 name and type T, represented at runtime by manifest.

3. class AttributeMap extends AnyRef

   

   An immutable map where a key is the tuple (String,T) for a fixed type T and can only be associated with values of type T.

   An immutable map where a key is the tuple (String,T) for a fixed type T and can only be associated with values of type T. It is therefore possible for this map to contain mappings for keys with the same label but different types. Excluding this possibility is the responsibility of the client if desired.

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[DateTime] = 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. final class DateTime extends Ordered[DateTime] with Renderable with Product6[Int, Int, Int, Int, Int, Int]

    

    Immutable, fast and efficient Date + Time implementation without any dependencies.

    Immutable, fast and efficient Date + Time implementation without any dependencies. Does not support TimeZones, all DateTime values are always GMT based. Note that this implementation discards milliseconds (i.e. rounds down to full seconds).

15. type EntityBody = Process[Task, ByteVector]

    

16. sealed trait EntityDecoder[+T] extends AnyRef

    

    A type that can be used to decode an EntityBody EntityDecoder is used to attempt to decode an EntityBody returning the entire resulting T.

    A type that can be used to decode an EntityBody EntityDecoder is used to attempt to decode an EntityBody returning the entire resulting T. If an error occurs it will result in a failed Task These are not streaming constructs.

    T

    result type produced by the decoder

17. trait EntityDecoderInstances extends AnyRef

    

    Implementations of the EntityDecoder instances

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

    

19. trait HasQValue extends AnyRef

    

20. sealed trait Header extends Renderable with Product

    

    Abstract representation o the HTTP header

    Abstract representation o the HTTP header

    See also

    org.http4s.HeaderKey

21. sealed trait HeaderKey extends AnyRef

    

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

    

    A collection of HTTP Headers

23. trait Http4s extends Http4sInstances with Http4sFunctions with Http4sSyntax

    

24. trait Http4sFunctions extends QValueFunctions with UriFunctions

    

25. trait Http4sInstances extends AllInstances with TaskInstances with EntityDecoderInstances with HttpVersionInstances with WritableInstances with CharsetRangeInstances with QValueInstances with MethodInstances with StatusInstances

    

26. trait Http4sSyntax extends CaseInsensitiveStringSyntax with MessageSyntax

    

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

    

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

29. trait HttpVersionInstances extends AnyRef

    

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

    

31. sealed class MediaRange extends HasQValue with Renderable

    

32. sealed class MediaType extends MediaRange

    

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

34. trait MessageOps extends Any

    

35. trait MessageSyntax extends AnyRef

    

36. final case class Method extends Renderable 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]

37. trait MethodInstances extends AnyRef

    

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

    

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

    

40. case class ParseFailure(sanitized: String, details: String = "") extends 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.

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

    

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

43. trait QValueFunctions extends AnyRef

    

44. trait QValueInstances extends AnyRef

    

45. sealed abstract class RangeUnit extends Renderable

    

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

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

    

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

49. trait ResponseOps extends MessageOps

    

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

    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]

51. trait StatusInstances extends AnyRef

    

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

    

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

    

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

    

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

    

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

    

    Representation of the Request URI

57. trait UriFunctions extends AnyRef

    

58. case class UriTemplate(scheme: Option[Scheme] = None, authority: Option[Authority] = None, path: Path = Nil, query: Option[Query] = None, fragment: Option[Fragment] = None) 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

59. case class Writable[-A](toEntity: (A) ⇒ Task[Entity], headers: Headers) extends Product with Serializable

    

60. trait WritableInstances extends WritableInstances0

    

61. trait WritableInstances0 extends AnyRef