Content

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.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

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

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 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.
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.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
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: Map[HttpString, HttpString]

a set of content-related HTTP headers.
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 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.
val stream: Stream[IO, Byte]

an fs2.Stream of Byte.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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( ... )

Related Docs: object Content | package http

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

Instance Constructors

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

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addHeaders(newHeaders: (HttpString, HttpString)*): Content

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

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val headers: Map[HttpString, HttpString]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def removeHeaders(headerNames: HttpString*): Content

val stream: Stream[IO, Byte]

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

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped