Packages

p

org.http4s

circe

package circe

Source
package.scala
Linear Supertypes
CirceInstances, JawnInstances, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. circe
  2. CirceInstances
  3. JawnInstances
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait CirceEntityDecoder extends AnyRef

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

  2. trait CirceEntityEncoder extends AnyRef

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

  3. trait CirceInstances extends JawnInstances
  4. sealed abstract case class CirceInstancesBuilder extends Product with Serializable
  5. trait CirceSensitiveDataEntityDecoder extends AnyRef

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

    Derive EntityDecoder if implicit 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 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 Throwable that includes the sensitive JSON.

  6. final case class DecodingFailures(failures: NonEmptyList[DecodingFailure]) extends Exception with Product with Serializable

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

  7. trait JsonDecoder[F[_]] extends AnyRef

    F-algebra for separating the Sync required for extracting the Json from the body.

    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.

Value Members

  1. def accumulatingJsonOf[F[_], A](implicit F: Sync[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.

    Definition Classes
    CirceInstances
  2. def circeParseExceptionMessage: (ParsingFailure) ⇒ DecodeFailure
    Attributes
    protected
    Definition Classes
    CirceInstances
  3. implicit val decodeUri: Decoder[Uri]
    Definition Classes
    CirceInstances
  4. def defaultPrinter: Printer
    Attributes
    protected
    Definition Classes
    CirceInstances
  5. implicit val encodeUri: Encoder[Uri]
    Definition Classes
    CirceInstances
  6. def jawnDecoder[F[_], J](implicit arg0: Sync[F], arg1: Facade[J]): EntityDecoder[F, J]
    Definition Classes
    JawnInstances
  7. def jawnEmptyBodyMessage: DecodeFailure
    Attributes
    protected
    Definition Classes
    JawnInstances
  8. def jawnParseExceptionMessage: (ParseException) ⇒ DecodeFailure
    Attributes
    protected
    Definition Classes
    JawnInstances
  9. def jsonDecodeError: (Json, NonEmptyList[DecodingFailure]) ⇒ DecodeFailure
    Attributes
    protected
    Definition Classes
    CirceInstances
  10. implicit def jsonDecoder[F[_]](implicit arg0: Sync[F]): EntityDecoder[F, Json]
    Definition Classes
    CirceInstances
  11. def jsonDecoderAdaptive[F[_]](cutoff: Long, r1: MediaRange, rs: MediaRange*)(implicit arg0: Sync[F]): EntityDecoder[F, Json]
    Definition Classes
    CirceInstances
  12. def jsonDecoderByteBuffer[F[_]](implicit arg0: Sync[F]): EntityDecoder[F, Json]
    Definition Classes
    CirceInstances
  13. def jsonDecoderIncremental[F[_]](implicit arg0: Sync[F]): EntityDecoder[F, Json]
    Definition Classes
    CirceInstances
  14. implicit def jsonEncoder[F[_]]: EntityEncoder[F, Json]
    Definition Classes
    CirceInstances
  15. def jsonEncoderOf[F[_], A](implicit arg0: Encoder[A]): EntityEncoder[F, A]
    Definition Classes
    CirceInstances
  16. def jsonEncoderWithPrinter[F[_]](printer: Printer): EntityEncoder[F, Json]
    Definition Classes
    CirceInstances
  17. def jsonEncoderWithPrinterOf[F[_], A](printer: Printer)(implicit encoder: Encoder[A]): EntityEncoder[F, A]
    Definition Classes
    CirceInstances
  18. def jsonOf[F[_], A](implicit arg0: Sync[F], arg1: Decoder[A]): EntityDecoder[F, A]
    Definition Classes
    CirceInstances
  19. def jsonOfSensitive[F[_], A](redact: (Json) ⇒ String)(implicit arg0: Sync[F], arg1: Decoder[A]): EntityDecoder[F, A]
    Definition Classes
    CirceInstances
  20. def jsonOfWithMedia[F[_], A](r1: MediaRange, rs: MediaRange*)(implicit F: Sync[F], decoder: Decoder[A]): EntityDecoder[F, A]
    Definition Classes
    CirceInstances
  21. def jsonOfWithSensitiveMedia[F[_], A](redact: (Json) ⇒ String, r1: MediaRange, rs: MediaRange*)(implicit F: Sync[F], decoder: Decoder[A]): EntityDecoder[F, A]
    Definition Classes
    CirceInstances
  22. implicit def streamJsonArrayDecoder[F[_]](implicit arg0: Sync[F]): EntityDecoder[F, Stream[F, Json]]
    Definition Classes
    CirceInstances
  23. implicit def streamJsonArrayEncoder[F[_]]: EntityEncoder[F, Stream[F, Json]]
    Definition Classes
    CirceInstances
  24. def streamJsonArrayEncoderOf[F[_], A](implicit arg0: Encoder[A]): EntityEncoder[F, Stream[F, A]]
    Definition Classes
    CirceInstances
  25. def streamJsonArrayEncoderWithPrinter[F[_]](printer: Printer): EntityEncoder[F, Stream[F, Json]]

    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.

    Definition Classes
    CirceInstances
  26. 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.

    Definition Classes
    CirceInstances
  27. implicit final def toMessageSynax[F[_]](req: Message[F]): MessageSyntax[F]
    Definition Classes
    CirceInstances
  28. object CirceEntityCodec extends CirceEntityDecoder with CirceEntityEncoder
  29. object CirceEntityDecoder extends CirceEntityDecoder
  30. object CirceEntityEncoder extends CirceEntityEncoder
  31. object CirceInstances
  32. object CirceSensitiveDataEntityDecoder extends CirceSensitiveDataEntityDecoder
  33. object JsonDecoder

Inherited from CirceInstances

Inherited from JawnInstances

Inherited from AnyRef

Inherited from Any

Ungrouped