Message

Type Members

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

Definition Classes
Message → MessageOps

Abstract Value Members

abstract def attributes: AttributeMap
abstract def body: EntityBody[F]
abstract def change(body: EntityBody[F] = body, headers: Headers = headers, attributes: AttributeMap = attributes): Self

Attributes
protected
abstract def headers: Headers
abstract def httpVersion: HttpVersion
abstract 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 withBody, which uses an EntityEncoder to maintain the headers.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
final def as[T](implicit F: FlatMap[F], decoder: EntityDecoder[F, T]): F[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 effect which will generate the T

Definition Classes
MessageOps
final def asInstanceOf[T0]: T0

Definition Classes
Any
def attemptAs[T](implicit F: FlatMap[F], 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]

Definition Classes
Message → MessageOps
final def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Stream[F, String]
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.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def contentLength: Option[Long]
def contentType: Option[Content-Type]
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
final def filterHeaders(f: (Header) ⇒ Boolean)(implicit F: Functor[F]): 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
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def isChunked: Boolean
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def putHeaders(headers: Header*)(implicit F: Functor[F]): 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
final def removeHeader(key: HeaderKey)(implicit F: Functor[F]): Self

Definition Classes
MessageOps
final def replaceAllHeaders(headers: Header*)(implicit F: Functor[F]): Self

Replace the existing headers with those provided
Replace the existing headers with those provided

Definition Classes
MessageOps
final def replaceAllHeaders(headers: Headers)(implicit F: Functor[F]): 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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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 task might not complete unless the entire body has been consumed.
def transformHeaders(f: (Headers) ⇒ Headers)(implicit F: Functor[F]): Self

Definition Classes
Message → MessageOps
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def withAttribute[A](key: AttributeKey[A], value: A)(implicit F: Functor[F]): 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
def withAttribute[V](entry: AttributeEntry[V])(implicit F: Functor[F]): 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
def withBody[T](b: T)(implicit F: Monad[F], w: EntityEncoder[F, T]): F[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
final def withContentType(contentType: Content-Type)(implicit F: Functor[F]): Self

Definition Classes
MessageOps
final def withContentTypeOption(contentTypeO: Option[Content-Type])(implicit F: Functor[F]): Self

Definition Classes
MessageOps
def withEmptyBody(implicit F: Functor[F]): Self

Set an empty entity body on this message, and remove all payload headers that make no sense with an empty body.
final def withTrailerHeaders(trailerHeaders: F[Headers])(implicit F: Functor[F]): Self

Definition Classes
MessageOps
final def withType(t: MediaType)(implicit F: Functor[F]): 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
final def withoutContentType(implicit F: Functor[F]): Self

Definition Classes
MessageOps

Related Docs: object Message | package http4s

sealed trait Message[F[_]] extends MessageOps[F]

Type Members

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

Abstract Value Members

abstract def attributes: AttributeMap

abstract def body: EntityBody[F]

abstract def change(body: EntityBody[F] = body, headers: Headers = headers, attributes: AttributeMap = attributes): Self

abstract def headers: Headers

abstract def httpVersion: HttpVersion

abstract def withBodyStream(body: EntityBody[F]): Self

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def as[T](implicit F: FlatMap[F], decoder: EntityDecoder[F, T]): F[T]

final def asInstanceOf[T0]: T0

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

final def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Stream[F, String]

def charset: Option[Charset]

def clone(): AnyRef

def contentLength: Option[Long]

def contentType: Option[Content-Type]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def filterHeaders(f: (Header) ⇒ Boolean)(implicit F: Functor[F]): Self

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def isChunked: Boolean

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def putHeaders(headers: Header*)(implicit F: Functor[F]): Self

final def removeHeader(key: HeaderKey)(implicit F: Functor[F]): Self

final def replaceAllHeaders(headers: Header*)(implicit F: Functor[F]): Self

final def replaceAllHeaders(headers: Headers)(implicit F: Functor[F]): Self

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def trailerHeaders(implicit F: Applicative[F]): F[Headers]

def transformHeaders(f: (Headers) ⇒ Headers)(implicit F: Functor[F]): Self

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withAttribute[A](key: AttributeKey[A], value: A)(implicit F: Functor[F]): Self

def withAttribute[V](entry: AttributeEntry[V])(implicit F: Functor[F]): Self

def withBody[T](b: T)(implicit F: Monad[F], w: EntityEncoder[F, T]): F[Self]

final def withContentType(contentType: Content-Type)(implicit F: Functor[F]): Self

final def withContentTypeOption(contentTypeO: Option[Content-Type])(implicit F: Functor[F]): Self

def withEmptyBody(implicit F: Functor[F]): Self

final def withTrailerHeaders(trailerHeaders: F[Headers])(implicit F: Functor[F]): Self

final def withType(t: MediaType)(implicit F: Functor[F]): Self

final def withoutContentType(implicit F: Functor[F]): Self

Inherited from MessageOps[F]

Inherited from AnyRef

Inherited from Any

Ungrouped