Trait/Object

org.http4s

EntityDecoder

Related Docs: object EntityDecoder | package http4s

Permalink

trait EntityDecoder[T] extends AnyRef

A type that can be used to decode a Message EntityDecoder is used to attempt to decode a Message returning the entire resulting A. If an error occurs it will result in a failed Task The default decoders provided here are not streaming, but one could implement a streaming decoder by having the value of A be some kind of streaming construct.

T

result type produced by the decoder

Self Type
EntityDecoder[T]
Source
EntityDecoder.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EntityDecoder
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def consumes: Set[MediaRange]

    Permalink

    The MediaRanges this EntityDecoder knows how to handle

  2. abstract def decode(msg: Message, strict: Boolean): DecodeResult[T]

    Permalink

    Attempt to decode the body of the Message

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from EntityDecoder[T] to any2stringadd[EntityDecoder[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (EntityDecoder[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from EntityDecoder[T] to ArrowAssoc[EntityDecoder[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (EntityDecoder[T]) ⇒ Boolean, msg: ⇒ Any): EntityDecoder[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from EntityDecoder[T] to Ensuring[EntityDecoder[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (EntityDecoder[T]) ⇒ Boolean): EntityDecoder[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from EntityDecoder[T] to Ensuring[EntityDecoder[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): EntityDecoder[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from EntityDecoder[T] to Ensuring[EntityDecoder[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): EntityDecoder[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from EntityDecoder[T] to Ensuring[EntityDecoder[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def flatMapR[T2](f: (T) ⇒ DecodeResult[T2]): EntityDecoder[T2]

    Permalink
  16. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from EntityDecoder[T] to StringFormat[EntityDecoder[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  20. def map[T2](f: (T) ⇒ T2): EntityDecoder[T2]

    Permalink

    Make a new EntityDecoder by mapping the output result

  21. def matchesMediaType(mediaType: MediaType): Boolean

    Permalink

    true if this EntityDecoder knows how to decode the provided MediaType

  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. def orElse[T2](other: EntityDecoder[T2])(implicit ev: <~<[T, T2]): EntityDecoder[T2]

    Permalink

    Combine two EntityDecoder's

    Combine two EntityDecoder's

    The new EntityDecoder will first attempt to determine if it can perform the decode, and if not, defer to the second EntityDecoder

    other

    backup EntityDecoder

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

    Permalink
    Definition Classes
    AnyRef
  27. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def widen[B](implicit ev: <~<[T, B]): EntityDecoder[B]

    Permalink
  32. def [B](y: B): (EntityDecoder[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from EntityDecoder[T] to ArrowAssoc[EntityDecoder[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from EntityDecoder[T] to any2stringadd[EntityDecoder[T]]

Inherited by implicit conversion StringFormat from EntityDecoder[T] to StringFormat[EntityDecoder[T]]

Inherited by implicit conversion Ensuring from EntityDecoder[T] to Ensuring[EntityDecoder[T]]

Inherited by implicit conversion ArrowAssoc from EntityDecoder[T] to ArrowAssoc[EntityDecoder[T]]

Ungrouped