unidocs
0.23.20
API
Generated with
unidocs/org.http4s/EntityDecoder

EntityDecoder

org.http4s.EntityDecoder
See theEntityDecoder companion object
trait EntityDecoder[F[_], T]

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.

Type parameters

T

result type produced by the decoder

Attributes

Companion
object
Source
EntityDecoder.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Abstract methods

def consumes: Set[MediaRange]

The MediaRanges this EntityDecoder knows how to handle

The MediaRanges this EntityDecoder knows how to handle

Attributes

Source
EntityDecoder.scala
def decode(m: Media[F], strict: Boolean): DecodeResult[F, T]

Attempt to decode the body of the Message

Attempt to decode the body of the Message

Attributes

Source
EntityDecoder.scala

Concrete methods

def biflatMap[T2](f: DecodeFailure => DecodeResult[F, T2], s: T => DecodeResult[F, T2])(implicit F: Monad[F]): EntityDecoder[F, T2]

Attributes

Source
EntityDecoder.scala
def bimap[T2](f: DecodeFailure => DecodeFailure, s: T => T2)(implicit F: Functor[F]): EntityDecoder[F, T2]

Attributes

Source
EntityDecoder.scala
def flatMapR[T2](f: T => DecodeResult[F, T2])(implicit F: Monad[F]): EntityDecoder[F, T2]

Attributes

Source
EntityDecoder.scala
def handleError(f: DecodeFailure => T)(implicit F: Functor[F]): EntityDecoder[F, T]

Attributes

Source
EntityDecoder.scala
def handleErrorWith(f: DecodeFailure => DecodeResult[F, T])(implicit F: Monad[F]): EntityDecoder[F, T]

Attributes

Source
EntityDecoder.scala
def map[T2](f: T => T2)(implicit F: Functor[F]): EntityDecoder[F, T2]

Make a new EntityDecoder by mapping the output result

Make a new EntityDecoder by mapping the output result

Attributes

Source
EntityDecoder.scala
def matchesMediaType(mediaType: MediaType): Boolean

true if this EntityDecoder knows how to decode the provided MediaType

true if this EntityDecoder knows how to decode the provided MediaType

Attributes

Source
EntityDecoder.scala
def orElse[T2 >: T](other: EntityDecoder[F, T2])(implicit F: Functor[F]): EntityDecoder[F, T2]

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

Value parameters

other

backup EntityDecoder

Attributes

Source
EntityDecoder.scala
def transform[T2](t: Either[DecodeFailure, T] => Either[DecodeFailure, T2])(implicit F: Functor[F]): EntityDecoder[F, T2]

Attributes

Source
EntityDecoder.scala
def transformWith[T2](f: Either[DecodeFailure, T] => DecodeResult[F, T2])(implicit F: Monad[F]): EntityDecoder[F, T2]

Attributes

Source
EntityDecoder.scala
def widen[T2 >: T]: EntityDecoder[F, T2]

Attributes

Source
EntityDecoder.scala
Generated with