Packages

object EntityEncoder extends EntityEncoderInstances

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EntityEncoder
  2. EntityEncoderInstances
  3. EntityEncoderInstances0
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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 apply[F[_], A](implicit ev: EntityEncoder[F, A]): EntityEncoder[F, A]

    summon an implicit EntityEncoder

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. implicit def byteArrayEncoder[F[_]](implicit arg0: Applicative[F]): EntityEncoder[F, Array[Byte]]
    Definition Classes
    EntityEncoderInstances
  7. implicit def charArrayEncoder[F[_]](implicit F: Applicative[F], charset: Charset = DefaultCharset): EntityEncoder[F, Array[Char]]
    Definition Classes
    EntityEncoderInstances
  8. implicit def chunkEncoder[F[_]](implicit arg0: Applicative[F]): EntityEncoder[F, Chunk[Byte]]
    Definition Classes
    EntityEncoderInstances
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  10. implicit def effectEncoder[F[_], A](implicit F: FlatMap[F], W: EntityEncoder[F, A]): EntityEncoder[F, F[A]]
    Definition Classes
    EntityEncoderInstances
  11. def emptyEncoder[F[_], A](implicit F: Applicative[F]): EntityEncoder[F, A]
    Definition Classes
    EntityEncoderInstances0
  12. def encodeBy[F[_], A](hs: Header*)(f: (A) ⇒ F[Entity[F]]): EntityEncoder[F, A]

    Create a new EntityEncoder

  13. def encodeBy[F[_], A](hs: Headers)(f: (A) ⇒ F[Entity[F]]): EntityEncoder[F, A]

    Create a new EntityEncoder

  14. implicit def entityBodyEncoder[F[_]](implicit F: Applicative[F]): EntityEncoder[F, EntityBody[F]]

    Encodes an entity body.

    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.

    Definition Classes
    EntityEncoderInstances
  15. implicit def entityEncoderContravariant[F[_]]: Contravariant[[β$0$]EntityEncoder[F, β$0$]]
    Definition Classes
    EntityEncoderInstances
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. implicit def fileEncoder[F[_]](implicit F: Sync[F]): EntityEncoder[F, File]
    Definition Classes
    EntityEncoderInstances
  19. implicit def filePathEncoder[F[_]](implicit arg0: Sync[F]): EntityEncoder[F, Path]
    Definition Classes
    EntityEncoderInstances
  20. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. implicit def inputStreamEncoder[F[_], IS <: InputStream](implicit arg0: Sync[F]): EntityEncoder[F, F[IS]]
    Definition Classes
    EntityEncoderInstances
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. implicit def multipartEncoder[F[_]](implicit arg0: Sync[F]): EntityEncoder[F, Multipart[F]]
    Definition Classes
    EntityEncoderInstances
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. implicit def readerEncoder[F[_], R <: Reader](implicit F: Sync[F], charset: Charset = DefaultCharset): EntityEncoder[F, F[R]]
    Definition Classes
    EntityEncoderInstances
  30. implicit def segmentEncoder[F[_]](implicit arg0: Applicative[F]): EntityEncoder[F, Segment[Byte, Unit]]
    Definition Classes
    EntityEncoderInstances
  31. implicit def serverSentEventEncoder[F[_]](implicit arg0: Applicative[F]): EntityEncoder[F, EventStream[F]]
    Definition Classes
    EntityEncoderInstances
  32. def showEncoder[F[_], A](implicit arg0: Applicative[F], charset: Charset = DefaultCharset, show: Show[A]): EntityEncoder[F, A]

    Encodes a value from its Show instance.

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

    Definition Classes
    EntityEncoderInstances0
  33. def simple[F[_], A](hs: Header*)(toChunk: (A) ⇒ Chunk[Byte])(implicit F: Applicative[F]): 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.

  34. implicit def streamEncoder[F[_], A](implicit F: Applicative[F], W: EntityEncoder[F, A]): EntityEncoder[F, Stream[F, A]]

    A stream encoder is intended for streaming, and does not calculate its bodies in advance.

    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.

    Definition Classes
    EntityEncoderInstances0
  35. implicit def stringEncoder[F[_]](implicit F: Applicative[F], charset: Charset = DefaultCharset): EntityEncoder[F, String]
    Definition Classes
    EntityEncoderInstances
  36. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  37. def toString(): String
    Definition Classes
    AnyRef → Any
  38. implicit def unitEncoder[F[_]](implicit arg0: Applicative[F]): EntityEncoder[F, Unit]
    Definition Classes
    EntityEncoderInstances
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Deprecated Value Members

  1. implicit def futureEncoder[F[_], A](implicit F: Async[F], ec: ExecutionContext, W: EntityEncoder[F, A]): EntityEncoder[F, Future[A]]
    Definition Classes
    EntityEncoderInstances0
    Annotations
    @deprecated
    Deprecated

    (Since version 0.18.5) This encoder breaks referential transparency and can cause unintended evaluation of expressions if you're not careful. See: https://github.com/http4s/http4s/issues/1757, which means you can potentially evaluate futures eagerly. You could end up executing a statement you don't intend to despite it not returning to you as a value.

    If you _must_ use futures, use something such as IO.fromFuture(IO(myFuture)) or define your own helper that does not evaluate the future eagerly, as otherwise it will evaluate the moment it's bound.

Inherited from EntityEncoderInstances

Inherited from EntityEncoderInstances0

Inherited from AnyRef

Inherited from Any

Ungrouped