org.http4s

Message

sealed trait Message extends MessageOps

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

Self Type
Message
See also

MessageSyntax, ResponseOps

Linear Supertypes
MessageOps, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Message
  2. MessageOps
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

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

    Definition Classes
    MessageMessageOps

Abstract Value Members

  1. abstract def attributes: AttributeMap

  2. abstract def body: EntityBody

  3. abstract def change(body: EntityBody = body, headers: Headers = headers, attributes: AttributeMap = attributes): Self

    Attributes
    protected
  4. abstract def headers: Headers

  5. abstract def httpVersion: HttpVersion

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def as[T](implicit decoder: EntityDecoder[T]): Task[T]

    Decode the Message to the specified type

    Decode the Message to the specified type

    If no valid Status has been described, allow Ok

    T

    type of the result

    decoder

    EntityDecoder used to decode the Message

    returns

    the Task which will generate the T

    Definition Classes
    MessageOps
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def attemptAs[T](implicit decoder: EntityDecoder[T]): DecodeResult[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 Task which will generate the DecodeResult[T]

    Definition Classes
    MessageMessageOps
  9. final def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Process[Task, String]

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

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def contentLength: Option[Int]

  13. def contentType: Option[Content-Type]

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  16. def filterHeaders(f: (Header) ⇒ Boolean): Self

    Remove headers that satisfy the predicate

    Remove headers that satisfy the predicate

    f

    predicate

    returns

    a new message object which lacks the specified headers

    Definition Classes
    MessageMessageOps
  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. def isChunked: Boolean

  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  25. def putHeaders(headers: Header*): Self

    Add the provided headers to the existing headers, replacing those of the same header name

    Add the provided headers to the existing headers, replacing those of the same header name

    Definition Classes
    MessageMessageOps
  26. def removeHeader(key: HeaderKey): Self

    Definition Classes
    MessageOps
  27. def replaceAllHeaders(headers: Headers): Self

    Replaces the Headers of the incoming Request object

    Replaces the Headers of the incoming Request object

    headers

    Headers containing the desired headers

    returns

    a new Request object

    Definition Classes
    MessageMessageOps
  28. def replaceAllHeaders(headers: Header*): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    MessageOps
  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  30. def toString(): String

    Definition Classes
    AnyRef → Any
  31. def trailerHeaders: Task[Headers]

    The trailer headers, as specified in Section 3.

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

  32. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def withAttribute[A](key: AttributeKey[A], value: A): Self

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

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

    A

    type of the value to store

    key

    AttributeKey with which to associate the value

    value

    value associated with the key

    returns

    a new message object with the key/value pair appended

    Definition Classes
    MessageMessageOps
  36. def withAttribute[V](entry: AttributeEntry[V]): Self

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

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

    V

    type of the value to store

    entry

    AttributeEntry entry to add

    returns

    a new message object with the key/value pair appended

    Definition Classes
    MessageOps
  37. def withBody[T](b: T)(implicit w: EntityEncoder[T]): Task[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

  38. def withContentType(contentType: Option[Content-Type]): Self

    Definition Classes
    MessageOps
  39. def withTrailerHeaders(trailerHeaders: Task[Headers]): Self

    Definition Classes
    MessageOps
  40. def withType(t: MediaType): Self

    Added the `Content-Type` header to the response

    Added the `Content-Type` header to the response

    Definition Classes
    MessageOps

Deprecated Value Members

  1. final def withHeaders(headers: Header*): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    MessageOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.0) Use replaceAllHeaders. Will be removed in 0.11.x

  2. final def withHeaders(headers: Headers): Self

    Replaces the Headers of the incoming Request object

    Replaces the Headers of the incoming Request object

    headers

    Headers containing the desired headers

    returns

    a new Request object

    Definition Classes
    MessageOps
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.0) Use replaceAllHeaders. Will be removed in 0.11.x

Inherited from MessageOps

Inherited from AnyRef

Inherited from Any

Ungrouped