Packages

case class Content(stream: Stream[IO, Byte], headers: Map[HttpString, HttpString] = Map.empty) extends Product with Serializable

An HTTP message content body.

It is used to represent the content body for both HTTP requests & responses. It is composed of a lazy stream of byte that can be consumed if needed, and a set of content-related HTTP headers (such as Content-Length, Content-Type, etc.).

The provided stream is not pure and can only be consumed once.

stream

an fs2.Stream of Byte.

headers

a set of content-related HTTP headers.

Source
Content.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Content
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Content(stream: Stream[IO, Byte], headers: Map[HttpString, HttpString] = Map.empty)

    stream

    an fs2.Stream of Byte.

    headers

    a set of content-related HTTP headers.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addHeaders(newHeaders: (HttpString, HttpString)*): Content

    Add new HTTP headers to this content.

    Add new HTTP headers to this content.

    newHeaders

    the set of new HTTP header names and values to add to this content.

    returns

    a copy of the content with the new headers added.

  5. def as[A](implicit decoder: ContentDecoder[A]): IO[A]

    Create an cats.effect.IO that consumes this stream to a value of type A.

    Create an cats.effect.IO that consumes this stream to a value of type A.

    decoder

    the lol.http.ContentDecoder is able to read stream as values of type A.

    returns

    an cats.effect.IO that can be run to consume the stream.

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. val headers: Map[HttpString, HttpString]
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def removeHeaders(headerNames: HttpString*): Content

    Remove HTTP headers from this content.

    Remove HTTP headers from this content.

    headerNames

    the set of HTTP headers names to remove fromt this content.

    returns

    a copy of the content without the removed headers.

  17. val stream: Stream[IO, Byte]
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped