Trait/Object

org.http4s

EntityDecoder

Related Docs: object EntityDecoder | package http4s

Permalink

trait EntityDecoder[F[_], 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 effect. 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[F, T]
Annotations
@implicitNotFound( ... )
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

Abstract Value Members

  1. abstract def consumes: Set[MediaRange]

    Permalink

    The MediaRanges this EntityDecoder knows how to handle

  2. abstract def decode(msg: Message[F], strict: Boolean): DecodeResult[F, 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. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  5. def biflatMap[T2](f: (DecodeFailure) ⇒ DecodeResult[F, T2], s: (T) ⇒ DecodeResult[F, T2])(implicit F: Monad[F]): EntityDecoder[F, T2]

    Permalink
  6. def bimap[T2](f: (DecodeFailure) ⇒ DecodeFailure, s: (T) ⇒ T2)(implicit F: Functor[F]): EntityDecoder[F, T2]

    Permalink
  7. def clone(): AnyRef

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

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

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

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

    Permalink
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def handleError(f: (DecodeFailure) ⇒ T)(implicit F: Functor[F]): EntityDecoder[F, T]

    Permalink
  14. def handleErrorWith(f: (DecodeFailure) ⇒ DecodeResult[F, T])(implicit F: Monad[F]): EntityDecoder[F, T]

    Permalink
  15. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  17. def map[T2](f: (T) ⇒ T2)(implicit F: Functor[F]): EntityDecoder[F, T2]

    Permalink

    Make a new EntityDecoder by mapping the output result

  18. def matchesMediaType(mediaType: MediaType): Boolean

    Permalink

    true if this EntityDecoder knows how to decode the provided MediaType

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

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

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

    Permalink
    Definition Classes
    AnyRef
  22. def orElse[T2 >: T](other: EntityDecoder[F, T2])(implicit F: Functor[F]): EntityDecoder[F, 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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  25. def transform[T2](t: (Either[DecodeFailure, T]) ⇒ Either[DecodeFailure, T2])(implicit F: Functor[F]): EntityDecoder[F, T2]

    Permalink
  26. def transformWith[T2](f: (Either[DecodeFailure, T]) ⇒ DecodeResult[F, T2])(implicit F: Monad[F]): EntityDecoder[F, T2]

    Permalink
  27. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def widen[T2 >: T]: EntityDecoder[F, T2]

    Permalink

Inherited from AnyRef

Inherited from Any

Ungrouped