zio-http
API
Generated with
zio-http/zio.http/Response

Response

zio.http.Response
See theResponse companion object
final case class Response(status: Status = ..., headers: Headers = ..., body: Body = ...)

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type

Members list

Value members

Concrete methods

def addCookie(cookie: Response): Response
def addCookies(cookie: Response, cookies: Response*): Response
def addFlash[A](setter: Setter[A]): Response

Adds flash values to the cookie-based flash-scope.

Adds flash values to the cookie-based flash-scope.

Attributes

def bodyAs[A](implicit codec: BinaryCodec[A], trace: Trace): Task[A]

Decodes the content of the body as a value based on a zio-schema zio.schema.codec.BinaryCodec.

Decodes the content of the body as a value based on a zio-schema zio.schema.codec.BinaryCodec.

Example for json:

import zio.schema.json.codec._
case class Person(name: String, age: Int)
implicit val schema: Schema[Person] = DeriveSchema.gen[Person]
val response = ???
val decodedPerson = response.to[Person]

Attributes

def collect(implicit trace: Trace): ZIO[Any, Nothing, Response]

Collects the potentially streaming body of the response into a single chunk.

Collects the potentially streaming body of the response into a single chunk.

Any errors that occur from the collection of the body will be caught and propagated to the Body

Attributes

def contentType(mediaType: MediaType): Response
def ignoreBody(implicit trace: Trace): ZIO[Any, Nothing, Response]

Consumes the streaming body fully and then discards it while also ignoring any failures

Consumes the streaming body fully and then discards it while also ignoring any failures

Attributes

def patch(p: Patch)(implicit trace: Trace): Response
def status(status: Status): Response

Sets the status of the response

Sets the status of the response

Attributes

def toHandler(implicit trace: Trace): Handler[Any, Nothing, Any, Response]

Creates an Http from a Response

Creates an Http from a Response

Attributes

override def updateHeaders(update: Headers => Headers)(implicit trace: Trace): Response

Updates the current Headers with new one, using the provided update function passed.

Updates the current Headers with new one, using the provided update function passed.

Attributes

Definition Classes

Inherited methods

final def addHeader[T](value: T)(implicit schema: Schema[T]): Response

Adds headers based on the given value. The type of the value must have a schema and be a case class and all fields will be added as headers. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. The header names are the field names.

Adds headers based on the given value. The type of the value must have a schema and be a case class and all fields will be added as headers. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. The header names are the field names.

Attributes

Inherited from:
HeaderModifier
final def addHeader[T](name: String, value: T)(implicit schema: Schema[T]): Response

Adds a header / headers with the specified name and based on the given value. The value type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Adds a header / headers with the specified name and based on the given value. The value type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Attributes

Inherited from:
HeaderModifier
protected def addHeader(name: CharSequence, value: CharSequence): Response

Attributes

Inherited from:
HeaderModifier
final def addHeader(header: Header): Response

Attributes

Inherited from:
HeaderModifier
final def addHeaders(headers: Iterable[(CharSequence, CharSequence)]): Response

Attributes

Inherited from:
HeaderModifier
final def addHeaders(headers: Headers): Response

Attributes

Inherited from:
HeaderModifier
final def hasContentType(mediaType: MediaType): Boolean

Attributes

Inherited from:
HeaderChecks
final def hasContentType(value: CharSequence): Boolean

Attributes

Inherited from:
HeaderChecks
final def hasFormMultipartContentType: Boolean

Attributes

Inherited from:
HeaderChecks
final def hasFormUrlencodedContentType: Boolean

Attributes

Inherited from:
HeaderChecks
final def hasHeader(header: Header): Boolean

Attributes

Inherited from:
HeaderChecks
final def hasHeader(headerType: HeaderType): Boolean

Attributes

Inherited from:
HeaderChecks
final def hasHeader(name: CharSequence): Boolean

Attributes

Inherited from:
HeaderChecks
final def hasJsonContentType: Boolean

Attributes

Inherited from:
HeaderChecks
final def hasTextPlainContentType: Boolean

Attributes

Inherited from:
HeaderChecks
final def hasXhtmlXmlContentType: Boolean

Attributes

Inherited from:
HeaderChecks
final def hasXmlContentType: Boolean

Attributes

Inherited from:
HeaderChecks
final def header[T](implicit schema: Schema[T]): Either[HeaderError, T]

Retrieves headers as a value of the specified type. The type must have a schema and be a case class and all fields must be headers. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Headers are selected by field names.

Retrieves headers as a value of the specified type. The type must have a schema and be a case class and all fields must be headers. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Headers are selected by field names.

Attributes

Inherited from:
HeaderGetters
final def header[T](name: String)(implicit schema: Schema[T]): Either[HeaderError, T]

Retrieves the header with the specified name as a value of the specified type. The type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Retrieves the header with the specified name as a value of the specified type. The type must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Attributes

Inherited from:
HeaderGetters
final def header(headerType: HeaderType): Option[headerType.HeaderValue]

Gets a header or returns None if the header was not present or it could not be parsed

Gets a header or returns None if the header was not present or it could not be parsed

Attributes

Inherited from:
HeaderGetters
final def headerOrElse[T](default: => T)(implicit schema: Schema[T]): T

Retrieves headers as a value of the specified type T, or returns a default value if the headers are not present or could not be parsed. The type T must have a schema and be a case class and all fields must be headers. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Headers are selected by field names.

Retrieves headers as a value of the specified type T, or returns a default value if the headers are not present or could not be parsed. The type T must have a schema and be a case class and all fields must be headers. So fields must be of primitive types (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these. Headers are selected by field names.

Attributes

Inherited from:
HeaderGetters
final def headerOrElse[T](name: String, default: => T)(implicit schema: Schema[T]): T

Retrieves the header with the specified name as a value of the specified type T, or returns a default value if the header is not present or could not be parsed. The type T must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Retrieves the header with the specified name as a value of the specified type T, or returns a default value if the header is not present or could not be parsed. The type T must have a schema and can be a primitive type (e.g. Int, String, UUID, Instant etc.), a case class with a single field or a collection of either of these.

Attributes

Inherited from:
HeaderGetters
final def headerOrFail(headerType: HeaderType): Option[Either[String, headerType.HeaderValue]]

Gets a header. If the header is not present, returns None. If the header could not be parsed it returns the parsing error

Gets a header. If the header is not present, returns None. If the header could not be parsed it returns the parsing error

Attributes

Inherited from:
HeaderGetters
final def headerZIO[T](name: String)(implicit schema: Schema[T]): IO[HeaderError, T]

Attributes

Inherited from:
HeaderGetters
final def headers(headerType: HeaderType): Chunk[headerType.HeaderValue]

Attributes

Inherited from:
HeaderGetters
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def rawHeader(headerType: HeaderType): Option[String]

Gets the raw unparsed header value

Gets the raw unparsed header value

Attributes

Inherited from:
HeaderGetters
final def rawHeader(name: CharSequence): Option[String]

Gets the raw unparsed header value

Gets the raw unparsed header value

Attributes

Inherited from:
HeaderGetters
def rawHeaders(name: CharSequence): Chunk[String]

Attributes

Inherited from:
HeaderGetters
final def removeHeader(name: String): Response

Attributes

Inherited from:
HeaderModifier
final def removeHeader(headerType: HeaderType): Response

Attributes

Inherited from:
HeaderModifier
final def removeHeaders(headers: Set[String]): Response

Attributes

Inherited from:
HeaderModifier
final def setHeaders(headers: Headers): Response

Attributes

Inherited from:
HeaderModifier
Generated with