Packages

sealed trait Message[F[_]] extends AnyRef

Represents a HTTP Message. The interesting subclasses are Request and Response.

Self Type
Message[F]
Source
Message.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Request, Response
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Message
  2. AnyRef
  3. 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

Type Members

  1. abstract type Self <: Message[F] { type Self = Message.this.Self }

Abstract Value Members

  1. abstract def attributes: Vault
  2. abstract def body: EntityBody[F]
  3. abstract def headers: Headers
  4. abstract def httpVersion: HttpVersion

Concrete Value Members

  1. def as[A](implicit F: MonadError[F, Throwable], decoder: EntityDecoder[F, A]): F[A]

    Decode the Message to the specified type

    Decode the Message to the specified type

    If no valid Status has been described, allow Ok

    A

    type of the result

    decoder

    EntityDecoder used to decode the Message

    returns

    the effect which will generate the A

  2. def attemptAs[T](implicit decoder: EntityDecoder[F, T]): DecodeResult[F, T]

    Decode the Message to the specified type

    Decode the Message to the specified type

    T

    type of the result

    decoder

    EntityDecoder used to decode the Message

    returns

    the effect which will generate the DecodeResult[T]

  3. def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Stream[F, String]
  4. def charset: Option[Charset]

    Returns the charset parameter of the Content-Type header, if present.

    Returns the charset parameter of the Content-Type header, if present. Does not introspect the body for media types that define a charset internally.

  5. def contentLength: Option[Long]
  6. def contentType: Option[Content-Type]
  7. def filterHeaders(f: (Header) ⇒ Boolean): Self

    Keep headers that satisfy the predicate

    Keep headers that satisfy the predicate

    f

    predicate

    returns

    a new message object which has only headers that satisfy the predicate

  8. def isChunked: Boolean
  9. def putHeaders(headers: Header*): Self

    Add the provided headers to the existing headers, replacing those of the same header name The passed headers are assumed to contain no duplicate Singleton headers.

  10. def removeHeader(key: HeaderKey): Self
  11. def trailerHeaders(implicit F: Applicative[F]): F[Headers]

    The trailer headers, as specified in Section 3.6.1 of RFC 2616.

    The trailer headers, as specified in Section 3.6.1 of RFC 2616. The resulting F might not complete until the entire body has been consumed.

  12. def transformHeaders(f: (Headers) ⇒ Headers): Self
  13. def withAttribute[A](key: Key[A], value: A): Self

    Generates a new message object with the specified key/value pair appended to the AttributeMap

    Generates a new message object with the specified key/value pair appended to the AttributeMap

    A

    type of the value to store

    key

    Key with which to associate the value

    value

    value associated with the key

    returns

    a new message object with the key/value pair appended

  14. def withAttributes(attributes: Vault): Self
  15. def withBodyStream(body: EntityBody[F]): Self

    Sets the entity body without affecting headers such as Transfer-Encoding or Content-Length.

    Sets the entity body without affecting headers such as Transfer-Encoding or Content-Length. Most use cases are better served by withEntity, which uses an EntityEncoder to maintain the headers.

  16. def withContentType(contentType: Content-Type): Self
  17. def withContentTypeOption(contentTypeO: Option[Content-Type]): Self
  18. def withEmptyBody: Self

    Set an empty entity body on this message, and remove all payload headers that make no sense with an empty body.

  19. def withEntity[T](b: T)(implicit w: EntityEncoder[F, T]): Self

    Replace the body of this message with a new body

    Replace the body of this message with a new body

    T

    type of the Body

    b

    body to attach to this method

    w

    EntityEncoder with which to convert the body to an EntityBody

    returns

    a new message with the new body

  20. def withHeaders(headers: Header*): Self
  21. def withHeaders(headers: Headers): Self
  22. def withHttpVersion(httpVersion: HttpVersion): Self
  23. def withTrailerHeaders(trailerHeaders: F[Headers]): Self
  24. def withoutAttribute(key: Key[_]): Self

    Returns a new message object without the specified key in the AttributeMap

    Returns a new message object without the specified key in the AttributeMap

    key

    Key to remove

    returns

    a new message object without the key

  25. def withoutContentType: Self
  26. def withoutTrailerHeaders: Self

Deprecated Value Members

  1. def replaceAllHeaders(headers: Header*): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Annotations
    @deprecated
    Deprecated

    (Since version 0.20.0-M2) Use withHeaders instead

  2. def replaceAllHeaders(headers: Headers): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Annotations
    @deprecated
    Deprecated

    (Since version 0.20.0-M2) Use withHeaders instead

  3. def withBody[T](b: T)(implicit F: Applicative[F], w: EntityEncoder[F, T]): F[Self]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19) Use withEntity

  4. def withType(t: MediaType)(implicit F: Functor[F]): Self
    Annotations
    @deprecated
    Deprecated

    (Since version 0.20.0-M2) Use withContentType(Content-Type(t)) instead