trait Body extends AnyRef

Represents the body of a request or response. The body can be a fixed chunk of bytes, a stream of bytes, or form data, or any type that can be encoded into such representations (such as textual data using some character encoding, the contents of files, JSON, etc.).

Self Type
Body
Linear Supertypes
AnyRef, Any
Known Subclasses
FetchBody
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Body
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def asArray(implicit trace: Trace): Task[Array[Byte]]

    Returns an effect that decodes the content of the body as array of bytes.

    Returns an effect that decodes the content of the body as array of bytes. Note that attempting to decode a large stream of bytes into an array could result in an out of memory error.

  2. abstract def asChunk(implicit trace: Trace): Task[Chunk[Byte]]

    Returns an effect that decodes the content of the body as a chunk of bytes.

    Returns an effect that decodes the content of the body as a chunk of bytes. Note that attempting to decode a large stream of bytes into a chunk could result in an out of memory error.

  3. abstract def asStream(implicit trace: Trace): ZStream[Any, Throwable, Byte]

    Returns a stream that contains the bytes of the body.

    Returns a stream that contains the bytes of the body. This method is safe to use with large bodies, because the elements of the returned stream are lazily produced from the body.

  4. abstract def contentType(newMediaType: MediaType, newBoundary: Boundary): Body
  5. abstract def contentType(newMediaType: MediaType): Body

    Updates the media type attached to this body, returning a new Body with the updated media type

  6. abstract def isComplete: Boolean

    Returns whether or not the bytes of the body have been fully read.

  7. abstract def isEmpty: Boolean

    Returns whether or not the body is known to be empty.

    Returns whether or not the body is known to be empty. Note that some bodies may not be known to be empty until an attempt is made to consume them.

  8. abstract def knownContentLength: Option[Long]

    Returns whether or not the content length is known

  9. abstract def mediaType: Option[MediaType]

    Returns the media type for this Body

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def ++(that: Body): Body

    A right-biased way of combining two bodies.

    A right-biased way of combining two bodies. If either body is empty, the other will be returned. Otherwise, the right body will be returned.

  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def asMultipartForm(implicit trace: Trace): Task[Form]

    Returns an effect that decodes the content of the body as a multipart form.

    Returns an effect that decodes the content of the body as a multipart form. Note that attempting to decode a large stream of bytes into a form could result in an out of memory error.

  7. def asMultipartFormStream(implicit trace: Trace): Task[StreamingForm]

    Returns an effect that decodes the streaming body as a multipart form.

    Returns an effect that decodes the streaming body as a multipart form.

    The result is a stream of FormField objects, where each FormField may be a StreamingBinary or a Text object. The StreamingBinary object contains a stream of bytes, which has to be consumed asynchronously by the user to get the next FormField from the stream.

  8. def asMultipartMixed(implicit trace: Trace): Task[MultipartMixed]

    Returns an effect that decodes the streaming body as a multipart/mixed.

    Returns an effect that decodes the streaming body as a multipart/mixed.

    The result is a stream of Part objects, where each Part has headers and contents (binary stream), Part objects can be easily converted to a Body objects which provide vast API for extracting their contents.

  9. final def asString(charset: Charset)(implicit trace: Trace): Task[String]

    Decodes the content of the body as a string with the provided charset.

    Decodes the content of the body as a string with the provided charset. Note that attempting to decode a large stream of bytes into a string could result in an out of memory error.

  10. final def asString(implicit trace: Trace): Task[String]

    Decodes the content of the body as a string with the default charset.

    Decodes the content of the body as a string with the default charset. Note that attempting to decode a large stream of bytes into a string could result in an out of memory error.

  11. def asURLEncodedForm(implicit trace: Trace): Task[Form]

    Returns an effect that decodes the content of the body as form data.

  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def to[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 person = Person("John", 42)
val body = Body.from(person)
val decodedPerson = body.to[Person]
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped