org

http4s

package http4s

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. http4s
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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[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 DecodeResult[T] = EitherT[Task, ParseFailure, T]

  16. type EntityBody = Process[Task, ByteVector]

  17. 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 A.

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

    T

    result type produced by the decoder

  18. trait EntityDecoderInstances extends AnyRef

    Implementations of the EntityDecoder instances

  19. trait EntityEncoder[A] extends AnyRef

  20. trait EntityEncoderInstances extends EntityEncoderInstances0

  21. trait EntityEncoderInstances0 extends AnyRef

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

  23. trait HasQValue extends AnyRef

  24. sealed trait Header extends Renderable with Product

    Abstract representation o the HTTP header

    Abstract representation o the HTTP header

    See also

    org.http4s.HeaderKey

  25. sealed trait HeaderKey extends AnyRef

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

    A collection of HTTP Headers

  27. trait Http4s extends Http4sInstances with Http4sFunctions with Http4sSyntax

  28. trait Http4sFunctions extends QValueFunctions with UriFunctions

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

  30. trait Http4sSyntax extends CaseInsensitiveStringSyntax with MessageSyntax

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

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

  33. trait HttpVersionInstances extends AnyRef

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

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

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

  37. sealed class MediaRange extends HasQValue with Renderable

  38. sealed class MediaType extends MediaRange

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

  40. trait MessageOps extends Any

  41. trait MessageSyntax extends AnyRef

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

  43. trait MethodInstances extends AnyRef

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

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

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

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

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

  49. trait QValueFunctions extends AnyRef

  50. trait QValueInstances extends AnyRef

  51. 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 '='

  52. trait QueryOps extends AnyRef

  53. trait QueryParam[T] extends AnyRef

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

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

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

  56. trait QueryParamKeyLike[T] extends AnyRef

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

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

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

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

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

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

  63. trait ResponseOps extends MessageOps

  64. 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]

  65. trait StatusInstances extends AnyRef

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

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

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

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

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

  71. trait UriFunctions extends AnyRef

  72. 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
  73. final class UrlForm extends AnyVal

Value Members

  1. val ApiVersion: Http4sVersion

  2. object AttributeKey

  3. object AttributeMap

  4. object AuthScheme

  5. object BasicCredentials extends Serializable

  6. object BuildInfo extends Product with Serializable

    This object was generated by sbt-buildinfo.

  7. object CacheDirective

    A registry of cache-directives, as listed in http://www.iana.org/assignments/http-cache-directives/http-cache-directives.xhtml

  8. object Charset extends Serializable

  9. object CharsetRange extends CharsetRangeInstances

  10. object ContentCoding extends Registry with Serializable

  11. object DateTime

  12. object DecodeResult

  13. def EmptyBody: Process0[Nothing]

  14. object EntityDecoder extends EntityDecoderInstances

    EntityDecoder is used to attempt to decode an EntityBody This companion object provides a way to create new EntityDecoders along with some commonly used instances which can be resolved implicitly.

  15. object EntityEncoder extends EntityEncoderInstances

  16. object Header

  17. object HeaderKey

  18. object Headers

  19. object Http4s extends Http4s

  20. object Http4sFunctions extends Http4sFunctions

  21. object Http4sInstances extends Http4sInstances

  22. object Http4sSyntax extends Http4sSyntax

  23. object HttpVersion extends HttpVersionInstances with Serializable

  24. object LanguageTag extends Serializable

  25. object MediaRange extends Registry

  26. object MediaType extends Registry

  27. object Message

  28. object MessageSyntax extends MessageSyntax

  29. object Method extends MethodInstances with Serializable

  30. object ParseFailure extends Serializable

  31. object ParseResult

  32. object QValue extends QValueInstances with QValueFunctions

  33. object Query

  34. object QueryParam

  35. object QueryParamDecoder

  36. object QueryParamEncoder

  37. object QueryParamKeyLike

  38. object RangeUnit extends Serializable

  39. object Request extends Serializable

  40. object RequestCookieJar

  41. object Response extends Serializable

  42. object StaticFile

  43. object Status extends Serializable

  44. object TransferCoding extends Registry with Serializable

  45. object Uri extends UriFunctions with Serializable

  46. object UriTemplate extends Serializable

  47. object UrlForm

  48. package headers

  49. package parser

  50. package server

  51. package util

Inherited from AnyRef

Inherited from Any

Ungrouped