final class Response[+F[_]] extends Message[F] with Product with Serializable
- Alphabetic
- By Inheritance
- Response
- Serializable
- Product
- Equals
- Message
- Media
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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 addCookie(name: String, content: String, expires: Option[HttpDate] = None): Response[F]
Add a org.http4s.headers.Set-Cookie header with the provided values
- def addCookie(cookie: ResponseCookie): Response[F]
Add a Set-Cookie header for the provided ResponseCookie
- def addHeader[H](h: H)(implicit arg0: Header[H, Recurring]): SelfF[F]
Add a header to these headers.
Add a header to these headers. The header should be a type with a recurring
Headerinstance 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/*)))
*/*/*/*/*/
- Definition Classes
- Message
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val attributes: Vault
- final def body: EntityBody[F]
- Definition Classes
- Media
- final def bodyText[F2[x] >: F[x]](implicit RT: RaiseThrowable[F2], defaultCharset: Charset = `UTF-8`): Stream[F2, String]
- Definition Classes
- Media
- def canEqual(that: Any): Boolean
- Definition Classes
- Response → Equals
- def change[F1[_]](httpVersion: HttpVersion, entity: Entity[F1], headers: Headers, attributes: Vault): Response[F1]
- final def charset: Option[Charset]
- Definition Classes
- Media
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def contentLength: Option[Long]
- Definition Classes
- Media
- final def contentType: Option[Content-Type]
- Definition Classes
- Media
- def cookies: List[ResponseCookie]
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.
- def copy[F1[_]](status: Status = this.status, httpVersion: HttpVersion = this.httpVersion, headers: Headers = this.headers, entity: Entity[F1] = this.entity, attributes: Vault = this.attributes): Response[F1]
- def covary[F2[x] >: F[x]]: SelfF[F2]
Lifts this Message's body to the specified effect type.
- val entity: Entity[F]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def filterHeaders(f: (Raw) => Boolean): SelfF[F]
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
- Definition Classes
- Message
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- Response → AnyRef → Any
- val headers: Headers
- val httpVersion: HttpVersion
- def isChunked: Boolean
- Definition Classes
- Message
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def mapK[F2[x] >: F[x], G[_]](f: ~>[F2, G]): SelfF[G]
- Definition Classes
- Message
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productArity: Int
- Definition Classes
- Response → Product
- def productElement(n: Int): Any
- Definition Classes
- Response → Product
- def productElementName(n: Int): String
- Definition Classes
- Product
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def productIterator: Iterator[Any]
- Definition Classes
- Product
- def productPrefix: String
- Definition Classes
- Product
- def putHeaders(headers: ToRaw*): SelfF[F]
Add the provided headers to the existing headers, replacing those of the same header name
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/*)))
*/*/*/*/
- Definition Classes
- Message
- def removeCookie(name: String): Response[F]
Add a org.http4s.headers.Set-Cookie which will remove the specified cookie from the client
- def removeCookie(cookie: ResponseCookie): Response[F]
Add a org.http4s.headers.Set-Cookie which will remove the specified cookie from the client
- def removeHeader[A](implicit h: Header[A, _]): SelfF[F]
- Definition Classes
- Message
- def removeHeader(key: CIString): SelfF[F]
- Definition Classes
- Message
- def responsePrelude: ResponsePrelude
A projection of this response without the body.
- val status: Status
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toStrict[F1[x] >: F[x]](maxBytes: Option[Long])(implicit F: Concurrent[F1]): F1[SelfF[Pure]]
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: chunkedwith aContent-Lengthheader. 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.- 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.
- Definition Classes
- Message
- def toString(): String
- Definition Classes
- Response → AnyRef → Any
- def trailerHeaders[F1[x] >: F[x]](implicit F: Applicative[F1]): F1[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.
- Definition Classes
- Message
- def transformHeaders(f: (Headers) => Headers): SelfF[F]
- Definition Classes
- Message
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withAttribute[A](key: Key[A], value: A): SelfF[F]
Generates a new message object with the specified key/value pair appended to the attributes.
Generates a new message object with the specified key/value pair appended to the attributes.
- A
type of the value to store
- key
org.typelevel.vault.Key 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
- def withAttributes(attributes: Vault): SelfF[F]
- Definition Classes
- Message
- def withBodyStream[F1[x] >: F[x]](body: EntityBody[F1]): SelfF[F1]
Sets the entity body without affecting headers such as
Transfer-EncodingorContent-Length.Sets the entity body without affecting headers such as
Transfer-EncodingorContent-Length. Most use cases are better served by withEntity[F1[x]](entity*, 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.
- Definition Classes
- Message
- def withContentType(contentType: Content-Type): SelfF[F]
- Definition Classes
- Message
- def withContentTypeOption(contentTypeO: Option[Content-Type]): SelfF[F]
- Definition Classes
- Message
- def withEmptyBody: SelfF[Pure]
Set an Entity.Empty entity on this message, and remove all payload headers that make no sense with an empty body.
Set an Entity.Empty entity on this message, and remove all payload headers that make no sense with an empty body.
- Definition Classes
- Message
- def withEntity[F1[x]](entity: Entity[F1]): SelfF[F1]
- Definition Classes
- Message
- def withEntity[F1[x] >: F[x], T](b: T)(implicit w: EntityEncoder[F1, T]): SelfF[F1]
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 withHeaders(headers: ToRaw*): SelfF[F]
- Definition Classes
- Message
- def withHeaders(headers: Headers): SelfF[F]
- Definition Classes
- Message
- def withHttpVersion(httpVersion: HttpVersion): SelfF[F]
- Definition Classes
- Message
- def withStatus(status: Status): Response[F]
- def withTrailerHeaders[F1[x] >: F[x]](trailerHeaders: F1[Headers]): SelfF[F1]
- Definition Classes
- Message
- def withoutAttribute(key: Key[_]): SelfF[F]
Returns a new message object without the specified key in the attributes.
Returns a new message object without the specified key in the attributes.
- key
org.typelevel.vault.Key to remove
- returns
a new message object without the key
- Definition Classes
- Message
- def withoutContentType: SelfF[F]
- Definition Classes
- Message
- def withoutTrailerHeaders: SelfF[F]
- Definition Classes
- Message