ConfiguredDecoder

io.circe.derivation.ConfiguredDecoder
See theConfiguredDecoder companion object
trait ConfiguredDecoder[A](using conf: Configuration) extends Decoder[A]

Attributes

Companion:
object
Source:
ConfiguredDecoder.scala
Graph
Supertypes
trait Decoder[A]
class Object
trait Matchable
class Any
Known subtypes

Members list

Concise view

Value members

Concrete methods

final def decodeProduct(c: HCursor, fromProduct: Product => A): Result[A]

Attributes

Source:
ConfiguredDecoder.scala
final def decodeProductAccumulating(c: HCursor, fromProduct: Product => A): AccumulatingResult[A]

Attributes

Source:
ConfiguredDecoder.scala
final def decodeSum(c: HCursor): Result[A]

Attributes

Source:
ConfiguredDecoder.scala

Inherited methods

def apply(c: HCursor): Result[A]

Decode the given HCursor.

Decode the given HCursor.

Attributes

Inherited from:
Decoder
Source:
Decoder.scala
final def at(field: String): Decoder[A]

Create a new decoder that attempts to navigate to the specified field before decoding.

Create a new decoder that attempts to navigate to the specified field before decoding.

Attributes

Inherited from:
Decoder
Source:
Decoder.scala

Attributes

Inherited from:
Decoder
Source:
Decoder.scala
final def decodeJson(j: Json): Result[A]

Decode the given Json value.

Decode the given Json value.

Attributes

Inherited from:
Decoder
Source:
Decoder.scala
final def either[B](decodeB: Decoder[B]): Decoder[Either[A, B]]

Choose the first succeeding decoder, wrapping the result in a disjunction.

Choose the first succeeding decoder, wrapping the result in a disjunction.

Attributes

Inherited from:
Decoder
Source:
Decoder.scala
final def emap[B](f: A => Either[String, B]): Decoder[B]

Create a new decoder that performs some operation on the result if this one succeeds.

Create a new decoder that performs some operation on the result if this one succeeds.

Attributes

f

a function returning either a value or an error message

Inherited from:
Decoder
Source:
Decoder.scala
final def emapTry[B](f: A => Try[B]): Decoder[B]

Create a new decoder that performs some operation on the result if this one succeeds.

Create a new decoder that performs some operation on the result if this one succeeds.

Attributes

f

a function returning either a value or an error message

Inherited from:
Decoder
Source:
Decoder.scala
final def ensure(errors: A => List[String]): Decoder[A]

Build a new instance that fails with one or more errors if the condition does not hold for the result.

Build a new instance that fails with one or more errors if the condition does not hold for the result.

If the result of the function applied to the decoded value is the empty list, the new decoder will succeed with that value.

Attributes

Inherited from:
Decoder
Source:
Decoder.scala
final def ensure(pred: A => Boolean, message: => String): Decoder[A]

Build a new instance that fails if the condition does not hold for the result.

Build a new instance that fails if the condition does not hold for the result.

Note that in the case of chained calls to this method, only the first failure will be returned.

Attributes

Inherited from:
Decoder
Source:
Decoder.scala
final def flatMap[B](f: A => Decoder[B]): Decoder[B]

Monadically bind a function over this Decoder.

Monadically bind a function over this Decoder.

Attributes

Inherited from:
Decoder
Source:
Decoder.scala

Create a new instance that handles any of this instance's errors with the given function.

Create a new instance that handles any of this instance's errors with the given function.

Note that in the case of accumulating decoding, only the first error will be used in recovery.

Attributes

Inherited from:
Decoder
Source:
Decoder.scala
final def kleisli: Kleisli[Result, HCursor, A]

Convert to a Kleisli arrow.

Convert to a Kleisli arrow.

Attributes

Inherited from:
Decoder
Source:
Decoder.scala
final def map[B](f: A => B): Decoder[B]

Map a function over this Decoder.

Map a function over this Decoder.

Attributes

Inherited from:
Decoder
Source:
Decoder.scala
final def or[AA >: A](d: => Decoder[AA]): Decoder[AA]

Choose the first succeeding decoder.

Choose the first succeeding decoder.

Attributes

Inherited from:
Decoder
Source:
Decoder.scala
final def prepare(f: ACursor => ACursor): Decoder[A]

Create a new decoder that performs some operation on the incoming JSON before decoding.

Create a new decoder that performs some operation on the incoming JSON before decoding.

Attributes

Inherited from:
Decoder
Source:
Decoder.scala
final def product[B](fb: Decoder[B]): Decoder[(A, B)]

Run two decoders and return their results as a pair.

Run two decoders and return their results as a pair.

Attributes

Inherited from:
Decoder
Source:
Decoder.scala

Decode the given ACursor.

Decode the given ACursor.

Note that if you override the default implementation, you should also be sure to override tryDecodeAccumulating in order for fail-fast and accumulating decoding to be consistent.

Attributes

Inherited from:
Decoder
Source:
Decoder.scala

Attributes

Inherited from:
Decoder
Source:
Decoder.scala
final def validate(pred: HCursor => Boolean, message: => String): Decoder[A]

Build a new instance that fails if the condition does not hold for the input.

Build a new instance that fails if the condition does not hold for the input.

Attributes

Inherited from:
Decoder
Source:
Decoder.scala
final def validate(errors: HCursor => List[String]): Decoder[A]

Build a new instance that fails if the condition does not hold for the input.

Build a new instance that fails if the condition does not hold for the input.

Attributes

Inherited from:
Decoder
Source:
Decoder.scala
final def withErrorMessage(message: String): Decoder[A]

Build a new instance with the specified error message.

Build a new instance with the specified error message.

Attributes

Inherited from:
Decoder
Source:
Decoder.scala

Abstract fields

lazy val elemDecoders: List[Decoder[_]]

Attributes

Source:
ConfiguredDecoder.scala
lazy val elemDefaults: Default[A]

Attributes

Source:
ConfiguredDecoder.scala

Attributes

Source:
ConfiguredDecoder.scala

Attributes

Source:
ConfiguredDecoder.scala

Concrete fields