Message

org.http4s.Message

See theMessage companion object

sealed trait Message[+F[_]] extends Media[F]

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

Attributes

Companion: object
Source: Message.scala
Graph
Supertypes: trait Media[F]

class Object

trait Matchable

class Any
Known subtypes: class Request[F]

class Response[F]
Self type: Message[F]

Members list

Type members

Types

Attributes

Source: Message.scala

Value members

Abstract methods

Attributes

Source: Message.scala

Attributes

Source: Message.scala

Concrete methods

Add a header to these headers.

Add a header to these headers. The header should be a type with a recurring Header instance to ensure that the new value can be appended to any existing values.

>>> import org.http4s.headers.Accept

>>> val req = Request().addHeader(Accept(MediaRange.`application/*`))
>>> req.headers.get[Accept]
Some(Accept(NonEmptyList(application/*)))

>>> val req2 = req.addHeader(Accept(MediaRange.`text/*`))
>>> req2.headers.get[Accept]
Some(Accept(NonEmptyList(application/*, text/*)))

*/*/*/*/*/

Attributes

Source: Message.scala

Lifts this Message's body to the specified effect type.

Attributes

Definition Classes: Media
Source: Message.scala

Keep headers that satisfy the predicate

Value parameters

f: predicate

Attributes

Returns: a new message object which has only headers that satisfy the predicate
Source: Message.scala

Attributes

Source: Message.scala

Attributes

Source: Message.scala

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

>>> import org.http4s.headers.Accept

>>> val req = Request().putHeaders(Accept(MediaRange.`application/*`))
>>> req.headers.get[Accept]
Some(Accept(NonEmptyList(application/*)))

>>> val req2 = req.putHeaders(Accept(MediaRange.`text/*`))
>>> req2.headers.get[Accept]
Some(Accept(NonEmptyList(text/*)))

*/*/*/*/

Attributes

Source: Message.scala

Attributes

Source: Message.scala

Attributes

Source: Message.scala

Compiles the body stream to a single chunk and sets it as the body.

Compiles the body stream to a single chunk and sets it as the body. Replaces any Transfer-Encoding: chunked with a Content-Length header. It is the caller's responsibility to assure there is enough memory to materialize the entity body and control the time limits of that materialization.

Value parameters

maxBytes: maximum length of the entity stream. If the stream exceeds the limit then processing fails with the Message.EntityStreamException. Pass the scala.None if you don't want to limit the entity body.

Attributes

Source: Message.scala

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.

Attributes

Source: Message.scala

Attributes

Source: Message.scala

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

Type parameters

A: type of the value to store

Value parameters

key: org.typelevel.vault.Key with which to associate the value
value: value associated with the key

Attributes

Returns: a new message object with the key/value pair appended
Source: Message.scala

Attributes

Source: Message.scala

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.

WARNING: this method does not modify the headers of the message, and as a consequence headers may be incoherent with the body.