Message

Type Members

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

Abstract Value Members

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

Attributes
protected
abstract def headers: Headers
abstract def httpVersion: HttpVersion

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
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
final def asInstanceOf[T0]: T0

Definition Classes
Any
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]
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
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
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
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.
def removeHeader(key: HeaderKey): Self
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 F might not complete until the entire body has been consumed.
def transformHeaders(f: (Headers) ⇒ Headers): Self
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: 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
def withAttributes(attributes: Vault): Self
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.
def withContentType(contentType: Content-Type): Self
def withContentTypeOption(contentTypeO: Option[Content-Type]): Self
def withEmptyBody: Self

Set an empty entity body on this message, and remove all payload headers that make no sense with an empty body.
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
def withHeaders(headers: Header*): Self
def withHeaders(headers: Headers): Self
def withHttpVersion(httpVersion: HttpVersion): Self
def withTrailerHeaders(trailerHeaders: F[Headers]): Self
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
def withoutContentType: Self
def withoutTrailerHeaders: Self

Deprecated Value Members

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
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
def withBody[T](b: T)(implicit F: Applicative[F], w: EntityEncoder[F, T]): F[Self]

Annotations
@deprecated
Deprecated
(Since version 0.19) Use withEntity
def withType(t: MediaType)(implicit F: Functor[F]): Self

Annotations
@deprecated
Deprecated
(Since version 0.20.0-M2) Use withContentType(Content-Type(t)) instead

Related Docs: object Message | package http4s

sealed trait Message[F[_]] extends AnyRef

Type Members

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

Abstract Value Members

abstract def attributes: Vault

abstract def body: EntityBody[F]

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

abstract def headers: Headers

abstract def httpVersion: HttpVersion

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

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

final def asInstanceOf[T0]: T0

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

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

def filterHeaders(f: (Header) ⇒ Boolean): 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

def putHeaders(headers: Header*): Self

def removeHeader(key: HeaderKey): Self

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

def toString(): String

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

def transformHeaders(f: (Headers) ⇒ Headers): Self

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withAttribute[A](key: Key[A], value: A): Self

def withAttributes(attributes: Vault): Self

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

def withContentType(contentType: Content-Type): Self

def withContentTypeOption(contentTypeO: Option[Content-Type]): Self

def withEmptyBody: Self

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

def withHeaders(headers: Header*): Self

def withHeaders(headers: Headers): Self

def withHttpVersion(httpVersion: HttpVersion): Self

def withTrailerHeaders(trailerHeaders: F[Headers]): Self

def withoutAttribute(key: Key[_]): Self

def withoutContentType: Self

def withoutTrailerHeaders: Self

Deprecated Value Members

def replaceAllHeaders(headers: Header*): Self

def replaceAllHeaders(headers: Headers): Self

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped