Packages

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
Source
Message.scala
See also

MessageSyntax, ResponseOps

Linear Supertypes
MessageOps, AnyRef, Any
Known Subclasses
Request, Response
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Message
  2. MessageOps
  3. AnyRef
  4. 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 { type Self = Message.this.Self }
    Definition Classes
    Message → MessageOps

Abstract Value Members

  1. abstract def attributes: AttributeMap

    True if and only if the body is composed solely of Emits and Halt.

    True if and only if the body is composed solely of Emits and Halt. This indicates that the body can be re-run without side-effects.

  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
  6. abstract def withBodyStream(body: EntityBody): 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 withBody, which uses an EntityEncoder to maintain the headers.

Concrete 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 Message to any2stringadd[Message] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Message, B)
    Implicit
    This member is added by an implicit conversion from Message to ArrowAssoc[Message] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final 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
    Message → MessageOps
  9. final def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Stream[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
    @native() @throws( ... )
  12. def contentLength: Option[Long]
  13. def contentType: Option[Content-Type]
  14. def ensuring(cond: (Message) ⇒ Boolean, msg: ⇒ Any): Message
    Implicit
    This member is added by an implicit conversion from Message to Ensuring[Message] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (Message) ⇒ Boolean): Message
    Implicit
    This member is added by an implicit conversion from Message to Ensuring[Message] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: ⇒ Any): Message
    Implicit
    This member is added by an implicit conversion from Message to Ensuring[Message] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): Message
    Implicit
    This member is added by an implicit conversion from Message to Ensuring[Message] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. final 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
    MessageOps
  21. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Message to StringFormat[Message] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def isChunked: Boolean
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final 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.

    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.

    Definition Classes
    MessageOps
  31. final def removeHeader(key: HeaderKey): Self
    Definition Classes
    MessageOps
  32. final def replaceAllHeaders(headers: Header*): Self

    Replace the existing headers with those provided

    Replace the existing headers with those provided

    Definition Classes
    MessageOps
  33. final 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
    MessageOps
  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. def trailerHeaders: Task[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 task might not complete unless the entire body has been consumed.

  37. def transformHeaders(f: (Headers) ⇒ Headers): Self
    Definition Classes
    Message → MessageOps
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  41. 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
    Message → MessageOps
  42. 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
  43. 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

  44. final def withContentType(contentType: Option[Content-Type]): Self
    Definition Classes
    MessageOps
  45. def withEmptyBody: Self

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

  46. final def withTrailerHeaders(trailerHeaders: Task[Headers]): Self
    Definition Classes
    MessageOps
  47. final def withType(t: MediaType): Self

    Added the org.http4s.headers.Content-Type header to the response

    Added the org.http4s.headers.Content-Type header to the response

    Definition Classes
    MessageOps
  48. def →[B](y: B): (Message, B)
    Implicit
    This member is added by an implicit conversion from Message to ArrowAssoc[Message] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from MessageOps

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Message to any2stringadd[Message]

Inherited by implicit conversion StringFormat from Message to StringFormat[Message]

Inherited by implicit conversion Ensuring from Message to Ensuring[Message]

Inherited by implicit conversion ArrowAssoc from Message to ArrowAssoc[Message]

Ungrouped