Packages

object EntityDecoder

EntityDecoder is used to attempt to decode an EntityBody This companion object provides a way to create new EntityDecoders along with some commonly used instances which can be resolved implicitly.

Source
EntityDecoder.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EntityDecoder
  2. AnyRef
  3. 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[_], T](implicit ev: EntityDecoder[F, T]): EntityDecoder[F, T]

    summon an implicit EntityDecoder

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def binFile[F[_]](file: File, blocker: Blocker)(implicit F: Sync[F], cs: ContextShift[F]): EntityDecoder[F, File]
  7. implicit def binary[F[_]](implicit arg0: Sync[F]): EntityDecoder[F, Chunk[Byte]]
  8. implicit def byteArrayDecoder[F[_]](implicit arg0: Sync[F]): EntityDecoder[F, Array[Byte]]
  9. implicit def charArrayDecoder[F[_]](implicit arg0: Sync[F]): EntityDecoder[F, Array[Char]]
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. def collectBinary[F[_]](m: Media[F])(implicit arg0: Sync[F]): DecodeResult[F, Chunk[Byte]]

    Helper method which simply gathers the body into a single Chunk

  12. def decodeBy[F[_], T](r1: MediaRange, rs: MediaRange*)(f: (Media[F]) ⇒ DecodeResult[F, T])(implicit arg0: Applicative[F]): EntityDecoder[F, T]

    Create a new EntityDecoder

    Create a new EntityDecoder

    The new EntityDecoder will attempt to decode messages of type T only if the Message satisfies the provided MediaRange.

    Exceptions thrown by f are not caught. Care should be taken that recoverable errors are returned as a DecodeResult#failure, or that system errors are raised in F.

  13. def decodeText[F[_]](m: Media[F])(implicit F: Sync[F], defaultCharset: Charset = DefaultCharset): F[String]

    Decodes a message to a String

  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. def error[F[_], T](t: Throwable)(implicit F: Sync[F]): EntityDecoder[F, T]

    Provides a mechanism to fail decoding

  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def mixedMultipart[F[_]](blocker: Blocker, headerLimit: Int = 1024, maxSizeBeforeWrite: Int = 52428800, maxParts: Int = 50, failOnLimit: Boolean = false)(implicit arg0: Sync[F], arg1: ContextShift[F]): EntityDecoder[F, Multipart[F]]
  22. implicit def multipart[F[_]](implicit arg0: Sync[F]): EntityDecoder[F, Multipart[F]]
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. implicit def semigroupKForEntityDecoder[F[_]](implicit arg0: Functor[F]): SemigroupK[[β$0$]EntityDecoder[F, β$0$]]
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. implicit def text[F[_]](implicit F: Sync[F], defaultCharset: Charset = DefaultCharset): EntityDecoder[F, String]
  29. def textFile[F[_]](file: File, blocker: Blocker)(implicit F: Sync[F], cs: ContextShift[F]): EntityDecoder[F, File]
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. implicit def void[F[_]](implicit arg0: Sync[F]): EntityDecoder[F, Unit]

    An entity decoder that ignores the content and returns unit.

  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Deprecated Value Members

  1. def binaryChunk[F[_]](implicit arg0: Sync[F]): EntityDecoder[F, Chunk[Byte]]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.0-M2) Use binary instead

  2. def decodeString[F[_]](m: Media[F])(implicit F: Sync[F], defaultCharset: Charset = DefaultCharset): F[String]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.5) Can go into an infinite loop for charsets other than UTF-8. Replaced by decodeText

Inherited from AnyRef

Inherited from Any

Ungrouped