package circe
- Source
- package.scala
- Alphabetic
- By Inheritance
- circe
- CirceInstances
- JawnInstances
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
trait
CirceEntityDecoder extends AnyRef
Derive EntityDecoder if implicit io.circe.Decoder is in the scope without need to explicitly call
jsonOf
. -
trait
CirceEntityEncoder extends AnyRef
Derive EntityEncoder if implicit io.circe.Encoder is in the scope without need to explicitly call
jsonEncoderOf
. - trait CirceInstances extends JawnInstances
- sealed abstract case class CirceInstancesBuilder extends Product with Serializable
-
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. -
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.
-
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
-
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
-
def
circeParseExceptionMessage: (ParsingFailure) ⇒ DecodeFailure
- Attributes
- protected
- Definition Classes
- CirceInstances
-
val
circeSupportParser: CirceSupportParser
- Attributes
- protected
- Definition Classes
- CirceInstances
-
implicit
val
decodeUri: Decoder[Uri]
- Definition Classes
- CirceInstances
-
def
defaultPrinter: Printer
- Attributes
- protected
- Definition Classes
- CirceInstances
-
implicit
val
encodeUri: Encoder[Uri]
- Definition Classes
- CirceInstances
-
def
jawnDecoder[F[_], J](implicit arg0: Sync[F], arg1: Facade[J]): EntityDecoder[F, J]
- Definition Classes
- JawnInstances
-
def
jawnEmptyBodyMessage: DecodeFailure
- Attributes
- protected
- Definition Classes
- JawnInstances
-
def
jawnParseExceptionMessage: (ParseException) ⇒ DecodeFailure
- Attributes
- protected
- Definition Classes
- JawnInstances
-
def
jsonDecodeError: (Json, NonEmptyList[DecodingFailure]) ⇒ DecodeFailure
- Attributes
- protected
- Definition Classes
- CirceInstances
-
implicit
def
jsonDecoder[F[_]](implicit arg0: Sync[F]): EntityDecoder[F, Json]
- Definition Classes
- CirceInstances
-
def
jsonDecoderAdaptive[F[_]](cutoff: Long, r1: MediaRange, rs: MediaRange*)(implicit arg0: Sync[F]): EntityDecoder[F, Json]
- Definition Classes
- CirceInstances
-
def
jsonDecoderByteBuffer[F[_]](implicit arg0: Sync[F]): EntityDecoder[F, Json]
- Definition Classes
- CirceInstances
-
def
jsonDecoderIncremental[F[_]](implicit arg0: Sync[F]): EntityDecoder[F, Json]
- Definition Classes
- CirceInstances
-
implicit
def
jsonEncoder[F[_]]: EntityEncoder[F, Json]
- Definition Classes
- CirceInstances
-
def
jsonEncoderOf[F[_], A](implicit arg0: Encoder[A]): EntityEncoder[F, A]
- Definition Classes
- CirceInstances
-
def
jsonEncoderWithPrinter[F[_]](printer: Printer): EntityEncoder[F, Json]
- Definition Classes
- CirceInstances
-
def
jsonEncoderWithPrinterOf[F[_], A](printer: Printer)(implicit encoder: Encoder[A]): EntityEncoder[F, A]
- Definition Classes
- CirceInstances
-
def
jsonOf[F[_], A](implicit arg0: Sync[F], arg1: Decoder[A]): EntityDecoder[F, A]
- Definition Classes
- CirceInstances
-
def
jsonOfSensitive[F[_], A](redact: (Json) ⇒ String)(implicit arg0: Sync[F], arg1: Decoder[A]): EntityDecoder[F, A]
- Definition Classes
- CirceInstances
-
def
jsonOfWithMedia[F[_], A](r1: MediaRange, rs: MediaRange*)(implicit F: Sync[F], decoder: Decoder[A]): EntityDecoder[F, A]
- Definition Classes
- CirceInstances
-
def
jsonOfWithSensitiveMedia[F[_], A](redact: (Json) ⇒ String, r1: MediaRange, rs: MediaRange*)(implicit F: Sync[F], decoder: Decoder[A]): EntityDecoder[F, A]
- Definition Classes
- CirceInstances
-
implicit
def
streamJsonArrayDecoder[F[_]](implicit arg0: Sync[F]): EntityDecoder[F, Stream[F, Json]]
- Definition Classes
- CirceInstances
-
implicit
def
streamJsonArrayEncoder[F[_]]: EntityEncoder[F, Stream[F, Json]]
- Definition Classes
- CirceInstances
-
def
streamJsonArrayEncoderOf[F[_], A](implicit arg0: Encoder[A]): EntityEncoder[F, Stream[F, A]]
- Definition Classes
- CirceInstances
-
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
-
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
-
implicit final
def
toMessageSyntax[F[_]](req: Message[F]): MessageSyntax[F]
- Definition Classes
- CirceInstances
- object CirceEntityCodec extends CirceEntityDecoder with CirceEntityEncoder
- object CirceEntityDecoder extends CirceEntityDecoder
- object CirceEntityEncoder extends CirceEntityEncoder
- object CirceInstances
- object CirceSensitiveDataEntityDecoder extends CirceSensitiveDataEntityDecoder
- object JsonDecoder