EntityEncoder

Companion
class
class Object
trait Matchable
class Any

Value members

Concrete methods

def apply[F[_], A](implicit ev: EntityEncoder[F, A]): EntityEncoder[F, A]

summon an implicit EntityEncoder

summon an implicit EntityEncoder

def emptyEncoder[F[_], A]: EntityEncoder[F, A]
def encodeBy[F[_], A](hs: Headers)(f: A => Entity[F]): EntityEncoder[F, A]

Create a new EntityEncoder

Create a new EntityEncoder

def encodeBy[F[_], A](hs: ToRaw*)(f: A => Entity[F]): EntityEncoder[F, A]

Create a new EntityEncoder

Create a new EntityEncoder

def showEncoder[F[_], A](implicit charset: Charset, show: Show[A]): EntityEncoder[F, A]

Encodes a value from its Show instance. Too broad to be implicit, too useful to not exist.

Encodes a value from its Show instance. Too broad to be implicit, too useful to not exist.

def simple[F[_], A](hs: ToRaw*)(toChunk: A => Chunk[Byte]): EntityEncoder[F, A]

Create a new EntityEncoder

Create a new EntityEncoder

This constructor is a helper for types that can be serialized synchronously, for example a String.

Implicits

Implicits

implicit
def byteArrayEncoder[F[_]]: EntityEncoder[F, Array[Byte]]
implicit
def byteVectorEncoder[F[_]]: EntityEncoder[F, ByteVector]
implicit
def charArrayEncoder[F[_]](implicit charset: Charset): EntityEncoder[F, Array[Char]]
implicit
def chunkEncoder[F[_]]: EntityEncoder[F, Chunk[Byte]]
implicit

Encodes an entity body. Chunking of the stream is preserved. A Transfer-Encoding: chunked header is set, as we cannot know the content length without running the stream.

Encodes an entity body. Chunking of the stream is preserved. A Transfer-Encoding: chunked header is set, as we cannot know the content length without running the stream.

implicit
def entityEncoderContravariant[F[_]]: Contravariant[[_] =>> EntityEncoder[F, _$26]]
implicit
def inputStreamEncoder[F[_] : Sync, IS <: InputStream]: EntityEncoder[F, F[IS]]
implicit
implicit
def pathEncoder[F[_] : Files]: EntityEncoder[F, Path]
implicit
def readerEncoder[F[_], R <: Reader](implicit F: Sync[F], charset: Charset): EntityEncoder[F, F[R]]
implicit
def streamEncoder[F[_], A](implicit W: EntityEncoder[F, A]): EntityEncoder[F, Stream[F, A]]

A stream encoder is intended for streaming, and does not calculate its bodies in advance. As such, it does not calculate the Content-Length in advance. This is for use with chunked transfer encoding.

A stream encoder is intended for streaming, and does not calculate its bodies in advance. As such, it does not calculate the Content-Length in advance. This is for use with chunked transfer encoding.

implicit
def stringEncoder[F[_]](implicit charset: Charset): EntityEncoder[F, String]
implicit
def unitEncoder[F[_]]: EntityEncoder[F, Unit]

Deprecated implicits

@deprecated("Use pathEncoder with fs2.io.file.Path", "0.23.5")
implicit
def fileEncoder[F[_] : Files]: EntityEncoder[F, File]
Deprecated
@deprecated("Use pathEncoder with fs2.io.file.Path", "0.23.5")
implicit
def filePathEncoder[F[_] : Files]: EntityEncoder[F, Path]
Deprecated