org.http4s.circe

Members list

Concise view

Type members

Classlikes

Attributes

Source:
CirceEntityCodec.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Derive EntityDecoder if implicit io.circe.Decoder is in the scope without need to explicitly call jsonOf.

Derive EntityDecoder if implicit io.circe.Decoder is in the scope without need to explicitly call jsonOf.

Attributes

Companion:
object
Source:
CirceEntityDecoder.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CirceEntityCodec.type
object CirceEntityDecoder.type

Attributes

Companion:
trait
Source:
CirceEntityDecoder.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Derive EntityEncoder if implicit io.circe.Encoder is in the scope without need to explicitly call jsonEncoderOf.

Derive EntityEncoder if implicit io.circe.Encoder is in the scope without need to explicitly call jsonEncoderOf.

Attributes

Companion:
object
Source:
CirceEntityEncoder.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CirceEntityCodec.type
object CirceEntityEncoder.type

Attributes

Companion:
trait
Source:
CirceEntityEncoder.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Attributes

Companion:
object
Source:
CirceInstances.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Attributes

Companion:
trait
Source:
CirceInstances.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
sealed abstract case class CirceInstancesBuilder

Attributes

Source:
CirceInstances.scala
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
Self type

Derive EntityDecoder if implicit io.circe.Decoder is in the scope without need to explicitly call jsonOfSensitive

Derive EntityDecoder if implicit io.circe.Decoder is in the scope without need to explicitly call jsonOfSensitive

Note that it varies from CirceEntityDecoder in that, when failing to decode io.circe.Json to an A, the JSON will not be included in the raised java.lang.Exception. In the event the JSON includes sensitive data, this trait is, arguably, a better choice since it eliminates the risk of logging sensitive data, e.g. due to logging a raised java.lang.Throwable that includes the sensitive JSON.

Attributes

Companion:
object
Source:
CirceSensitiveDataEntityDecoder.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Attributes

Companion:
trait
Source:
CirceSensitiveDataEntityDecoder.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
final case class DecodingFailures(failures: NonEmptyList[DecodingFailure]) extends Exception

Wraps a list of decoding failures as an java.lang.Exception when using accumulatingJsonOf to decode JSON messages.

Wraps a list of decoding failures as an java.lang.Exception when using accumulatingJsonOf to decode JSON messages.

Attributes

Source:
DecodingFailures.scala
Graph
Supertypes
trait Product
trait Equals
class Exception
class Throwable
class Object
trait Matchable
class Any
trait JsonDecoder[F[_]]

F-algebra for separating the Sync required for extracting the Json from the body. As such if F is Sync at some layer, then this can be used to extract without the lower layer needing to be aware of the strong constraint.

F-algebra for separating the Sync required for extracting the Json from the body. As such if F is Sync at some layer, then this can be used to extract without the lower layer needing to be aware of the strong constraint.

Attributes

Companion:
object
Source:
JsonDecoder.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Attributes

Companion:
trait
Source:
JsonDecoder.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Value members

Inherited methods

def accumulatingJsonOf[F[_], A](implicit F: Concurrent[F], decoder: Decoder[A]): EntityDecoder[F, A]

An EntityDecoder that uses circe's accumulating decoder for decoding the JSON.

An EntityDecoder that uses circe's accumulating decoder for decoding the JSON.

In case of a failure, returns an InvalidMessageBodyFailure with the cause containing a DecodingFailures exception, from which the errors can be extracted.

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala

Attributes

Inherited from:
JawnInstances
Source:
JawnInstances.scala

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala
def jsonEncoderOf[F[_], A : Encoder]: EntityEncoder[F, A]

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala
def jsonEncoderWithPrinterOf[F[_], A](printer: Printer)(implicit encoder: Encoder[A]): EntityEncoder[F, A]

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala
def jsonOf[F[_] : Concurrent, A : Decoder]: EntityDecoder[F, A]

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala
def jsonOfSensitive[F[_] : Concurrent, A : Decoder](redact: Json => String): EntityDecoder[F, A]

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala
def jsonOfWithMedia[F[_], A](r1: MediaRange, rs: MediaRange*)(implicit F: Concurrent[F], decoder: Decoder[A]): EntityDecoder[F, A]

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala
def jsonOfWithSensitiveMedia[F[_], A](redact: Json => String, r1: MediaRange, rs: MediaRange*)(implicit F: Concurrent[F], decoder: Decoder[A]): EntityDecoder[F, A]

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala

An EntityEncoder for a fs2.Stream of JSONs, which will encode it as a single JSON array.

An EntityEncoder for a fs2.Stream of JSONs, which will encode it as a single JSON array.

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala
def streamJsonArrayEncoderWithPrinterOf[F[_], A](printer: Printer)(implicit encoder: Encoder[A]): EntityEncoder[F, Stream[F, A]]

An EntityEncoder for a fs2.Stream of values, which will encode it as a single JSON array.

An EntityEncoder for a fs2.Stream of values, which will encode it as a single JSON array.

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala

Implicits

Inherited implicits

implicit val decodeUri: Decoder[Uri]

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala
implicit val encodeUri: Encoder[Uri]

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala
implicit def jsonDecoder[F[_] : Concurrent]: EntityDecoder[F, Json]

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala
implicit def jsonEncoder[F[_]]: EntityEncoder[F, Json]

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala
implicit def streamJsonArrayEncoder[F[_]]: EntityEncoder[F, Stream[F, Json]]

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala
final implicit def toMessageSyntax[F[_]](req: Message[F]): MessageSyntax[F]

Attributes

Inherited from:
CirceInstances
Source:
CirceInstances.scala