Response

Instance Constructors

new Response(status: Status = Status.Ok, httpVersion: HttpVersion = HttpVersion.HTTP/1.1, headers: Headers = Headers.empty, body: EntityBody = http4s.this.`package`.EmptyBody, attributes: AttributeMap = AttributeMap.empty)

status
Status code and message
headers
Headers containing all response headers
body
scalaz.stream.Process[Task,Chunk] representing the possible body of the response
attributes
AttributeMap containing additional parameters which may be used by the http4s backend for additional processing such as java.io.File object

Type Members

type Self = Response

Definition Classes
Response → Message → MessageOps

Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
final def addCookie(name: String, content: String, expires: Option[HttpDate] = None): Self

Add a Set-Cookie header with the provided values
Add a Set-Cookie header with the provided values

Definition Classes
ResponseOps
final def addCookie(cookie: Cookie): Self

Add a Set-Cookie header for the provided Cookie
Add a Set-Cookie header for the provided Cookie

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

Definition Classes
Any
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
val attributes: AttributeMap

AttributeMap containing additional parameters which may be used by the http4s backend for additional processing such as java.
AttributeMap containing additional parameters which may be used by the http4s backend for additional processing such as java.io.File object

Definition Classes
Response → Message
val body: EntityBody

scalaz.
scalaz.stream.Process[Task,Chunk] representing the possible body of the response

Definition Classes
Response → Message
final def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Process[Task, String]

Definition Classes
Message
def cata[A](f: (Response) ⇒ A, a: ⇒ A): A

Definition Classes
MaybeResponse
def change(body: EntityBody, headers: Headers, attributes: AttributeMap): Self

Attributes
protected
Definition Classes
Response → Message
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.

Definition Classes
Message
def clone(): AnyRef

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

Definition Classes
Message
def contentType: Option[Content-Type]

Definition Classes
Message
def cookies: List[Cookie]

Returns a list of cookies from the org.http4s.headers.Set-Cookie headers.
Returns a list of cookies from the org.http4s.headers.Set-Cookie headers. Includes expired cookies, such as those that represent cookie deletion.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
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
def finalize(): Unit

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

Definition Classes
AnyRef → Any
val headers: Headers

Headers containing all response headers
Headers containing all response headers

Definition Classes
Response → Message
val httpVersion: HttpVersion

Definition Classes
Response → Message
def isBodyPure: Boolean

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.

Definition Classes
Message
def isChunked: Boolean

Definition Classes
Message
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 orElse[B >: Response](b: ⇒ B): B

Definition Classes
MaybeResponse
def orNotFound: Response

Definition Classes
MaybeResponse
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
final def removeCookie(name: String): Self

Add a org.http4s.headers.Set-Cookie which will remove the specified cookie from the client
Add a org.http4s.headers.Set-Cookie which will remove the specified cookie from the client

Definition Classes
ResponseOps
final def removeCookie(cookie: Cookie): Self

Add a org.http4s.headers.Set-Cookie which will remove the specified cookie from the client
Add a org.http4s.headers.Set-Cookie which will remove the specified cookie from the client

Definition Classes
ResponseOps
final def removeHeader(key: HeaderKey): Self

Definition Classes
MessageOps
final def replaceAllHeaders(headers: Header*): Self

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

Definition Classes
MessageOps
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
val status: Status

Status code and message
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toOption: Option[Response]

Definition Classes
MaybeResponse
def toString(): String

Definition Classes
Response → AnyRef → Any
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.

Definition Classes
Message
def transformHeaders(f: (Headers) ⇒ Headers): 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): 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]): 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 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

Definition Classes
Message
def withBodyStream(body: EntityBody): Response

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.

Definition Classes
Response → Message
final def withContentType(contentType: Option[Content-Type]): Self

Definition Classes
MessageOps
def withEmptyBody: Self

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

Definition Classes
Message
def withStatus(status: Status): Self

Change the status of this response object
Change the status of this response object
status
value to replace on the response object
returns
a new response object with the new status code

Definition Classes
Response → ResponseOps
final def withTrailerHeaders(trailerHeaders: Task[Headers]): Self

Definition Classes
MessageOps
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

Instance Constructors

new Response(status: Status = Status.Ok, httpVersion: HttpVersion = HttpVersion.HTTP/1.1, headers: Headers = Headers.empty, body: EntityBody = http4s.this.`package`.EmptyBody, attributes: AttributeMap = AttributeMap.empty)

Type Members

type Self = Response

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def addCookie(name: String, content: String, expires: Option[HttpDate] = None): Self

final def addCookie(cookie: Cookie): Self

final def as[T](implicit decoder: EntityDecoder[T]): Task[T]

final def asInstanceOf[T0]: T0

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

val attributes: AttributeMap

val body: EntityBody

final def bodyAsText(implicit defaultCharset: Charset = DefaultCharset): Process[Task, String]

def cata[A](f: (Response) ⇒ A, a: ⇒ A): A

def change(body: EntityBody, headers: Headers, attributes: AttributeMap): Self

def charset: Option[Charset]

def clone(): AnyRef

def contentLength: Option[Long]

def contentType: Option[Content-Type]

def cookies: List[Cookie]

final def eq(arg0: AnyRef): Boolean

final def filterHeaders(f: (Header) ⇒ Boolean): Self

def finalize(): Unit

final def getClass(): Class[_]

val headers: Headers

val httpVersion: HttpVersion

def isBodyPure: Boolean

def isChunked: Boolean

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def orElse[B >: Response](b: ⇒ B): B

def orNotFound: Response

final def putHeaders(headers: Header*): Self

final def removeCookie(name: String): Self

final def removeCookie(cookie: Cookie): Self

final def removeHeader(key: HeaderKey): Self

final def replaceAllHeaders(headers: Header*): Self

final def replaceAllHeaders(headers: Headers): Self

val status: Status

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

def toOption: Option[Response]

def toString(): String

def trailerHeaders: Task[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: AttributeKey[A], value: A): Self

def withAttribute[V](entry: AttributeEntry[V]): Self

def withBody[T](b: T)(implicit w: EntityEncoder[T]): Task[Self]

def withBodyStream(body: EntityBody): Response

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

def withEmptyBody: Self

def withStatus(status: Status): Self

final def withTrailerHeaders(trailerHeaders: Task[Headers]): Self

final def withType(t: MediaType): Self

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ResponseOps

Inherited from MaybeResponse

Inherited from Message

Inherited from MessageOps

Inherited from AnyRef

Inherited from Any

Ungrouped