Packages

final case class HttpRequest[F[_]](scheme: Scheme, host: HostPort, header: HttpRequestHeader, body: Stream[F, Byte]) extends HttpRequestOrResponse[F] with Product with Serializable

Model of Http Request sent by client.

host

Host/port where to perform the request to

header

Header of the request

body

Body of the request. If empty, no body will be emitted.

Self Type
HttpRequest[F]
Source
HttpRequestOrResponse.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpRequest
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. HttpRequestOrResponse
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HttpRequest(scheme: Scheme, host: HostPort, header: HttpRequestHeader, body: Stream[F, Byte])

    host

    Host/port where to perform the request to

    header

    Header of the request

    body

    Body of the request. If empty, no body will be emitted.

Type Members

  1. type Self = HttpRequest[F]
    Definition Classes
    HttpRequestHttpRequestOrResponse

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from HttpRequest[F] to any2stringadd[HttpRequest[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (HttpRequest[F], B)
    Implicit
    This member is added by an implicit conversion from HttpRequest[F] to ArrowAssoc[HttpRequest[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def appendHeader(header: HttpHeader, headers: HttpHeader*): Self

    appends supplied headers *

    appends supplied headers *

    Definition Classes
    HttpRequestOrResponse
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val body: Stream[F, Byte]
    Definition Classes
    HttpRequestHttpRequestOrResponse
  9. def bodyAs[A](implicit D: BodyDecoder[A], F: Catchable[F]): F[Attempt[A]]

    Decodes body with supplied decoder of A *

    Decodes body with supplied decoder of A *

    Definition Classes
    HttpRequestOrResponse
  10. def bodyAsByteVectorStream: Stream[F, ByteVector]

    gets body as stream of byteVectors *

    gets body as stream of byteVectors *

    Definition Classes
    HttpRequestOrResponse
  11. def bodyAsQuery(implicit F: Catchable[F]): F[Attempt[Query]]
  12. def bodyAsString(implicit F: Catchable[F]): F[Attempt[String]]

    decodes body as string with encoding supplied in ContentType *

    decodes body as string with encoding supplied in ContentType *

    Definition Classes
    HttpRequestOrResponse
  13. lazy val bodyIsChunked: Boolean

    yields to true, if body of this request shall be chunked *

    yields to true, if body of this request shall be chunked *

    Definition Classes
    HttpRequestOrResponse
  14. def bodySize: Option[Long]

    gets body size, if one specified *

    gets body size, if one specified *

    Definition Classes
    HttpRequestOrResponse
  15. def chunkedEncoding: Self

    configures encoding as chunked *

    configures encoding as chunked *

    Definition Classes
    HttpRequestOrResponse
  16. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. def contentType: Option[ContentType]

    gets ContentType, if one specififed *

    gets ContentType, if one specififed *

    Definition Classes
    HttpRequestOrResponse
  18. def ensuring(cond: (HttpRequest[F]) ⇒ Boolean, msg: ⇒ Any): HttpRequest[F]
    Implicit
    This member is added by an implicit conversion from HttpRequest[F] to Ensuring[HttpRequest[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: (HttpRequest[F]) ⇒ Boolean): HttpRequest[F]
    Implicit
    This member is added by an implicit conversion from HttpRequest[F] to Ensuring[HttpRequest[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean, msg: ⇒ Any): HttpRequest[F]
    Implicit
    This member is added by an implicit conversion from HttpRequest[F] to Ensuring[HttpRequest[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: Boolean): HttpRequest[F]
    Implicit
    This member is added by an implicit conversion from HttpRequest[F] to Ensuring[HttpRequest[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from HttpRequest[F] to StringFormat[HttpRequest[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  25. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  26. val header: HttpRequestHeader
  27. val host: HostPort
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def isSecure: Boolean
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  33. val scheme: Scheme
  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. def updateBody(body: Stream[F, Byte]): Self
    Attributes
    protected
    Definition Classes
    HttpRequestHttpRequestOrResponse
  36. def updateHeaders(headers: List[HttpHeader]): Self
    Attributes
    protected
    Definition Classes
    HttpRequestHttpRequestOrResponse
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. def withBody[A](a: A)(implicit W: BodyEncoder[A]): Self

    encodes body A given BodyEncoder exists *

    encodes body A given BodyEncoder exists *

    Definition Classes
    HttpRequestOrResponse
  41. def withBodySize(sz: Long): Self

    sets body size to supplied value *

    sets body size to supplied value *

    Definition Classes
    HttpRequestOrResponse
  42. def withContentType(ct: ContentType): Self

    updates content type to one specified *

    updates content type to one specified *

    Definition Classes
    HttpRequestOrResponse
  43. def withHeader(header: HttpHeader, headers: HttpHeader*): Self

    appends supplied headers.

    appends supplied headers. Unlike appendHeader headers are removed if they already exists *

    Definition Classes
    HttpRequestOrResponse
  44. def withHeaders[A](f: (List[HttpHeader]) ⇒ A): A
    Definition Classes
    HttpRequestOrResponse
  45. def withMethod(method: protocol.http.HttpMethod.Value): HttpRequest[F]
  46. def withQuery(query: Query): Self

    Adds supplied query as param in the Uri

  47. def withQueryBodyEncoded(q: Query): Self

    Encodes query params to body as application/x-www-form-urlencoded content.

    Encodes query params to body as application/x-www-form-urlencoded content. That means instead of passing query as part of request, they are encoded as utf8 body.

  48. def withStreamBody[A](body: Stream[F, A])(implicit E: StreamBodyEncoder[F, A]): Self

    allows to stream arbitrary sized stream of A to remote party (i.e.

    allows to stream arbitrary sized stream of A to remote party (i.e. upload) *

    Definition Classes
    HttpRequestOrResponse
  49. def withStreamBody1[A](a: ⇒ A)(implicit E: StreamBodyEncoder[F, A]): Self

    like stream except one A that is streamed lazily *

    like stream except one A that is streamed lazily *

    Definition Classes
    HttpRequestOrResponse
  50. def withUtf8Body(s: String): Self

    encodes body as utf8 string *

    encodes body as utf8 string *

    Definition Classes
    HttpRequestOrResponse
  51. def [B](y: B): (HttpRequest[F], B)
    Implicit
    This member is added by an implicit conversion from HttpRequest[F] to ArrowAssoc[HttpRequest[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HttpRequestOrResponse[F]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from HttpRequest[F] to any2stringadd[HttpRequest[F]]

Inherited by implicit conversion StringFormat from HttpRequest[F] to StringFormat[HttpRequest[F]]

Inherited by implicit conversion Ensuring from HttpRequest[F] to Ensuring[HttpRequest[F]]

Inherited by implicit conversion ArrowAssoc from HttpRequest[F] to ArrowAssoc[HttpRequest[F]]

Ungrouped