Circe core
0.14.7
API
Generated with
Circe core/io.circe/io.circe.derivation/ConfiguredCodec

ConfiguredCodec

io.circe.derivation.ConfiguredCodec
See theConfiguredCodec companion object
trait ConfiguredCodec[A] extends AsObject[A], ConfiguredDecoder[A], ConfiguredEncoder[A]

Attributes

Companion
object
Source
ConfiguredCodec.scala
Graph
Supertypes
trait AsObject[A]
trait AsObject[A]
trait AsRoot[A]
trait AsRoot[A]
trait Codec[A]
trait Encoder[A]
trait Decoder[A]
trait Serializable
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

final def apply(a: A): Json

Convert a value to JSON.

Convert a value to JSON.

Attributes

Inherited from:
AsObject
Source
Encoder.scala
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
final def contramap[B](f: B => A): Encoder[B]

Create a new Encoder by applying a function to a value of type B before encoding as an A.

Create a new Encoder by applying a function to a value of type B before encoding as an A.

Attributes

Inherited from:
Encoder
Source
Encoder.scala
final def contramapObject[B](f: B => A): AsObject[B]

Create a new Encoder.AsObject by applying a function to a value of type B before encoding as an A.

Create a new Encoder.AsObject by applying a function to a value of type B before encoding as an A.

Attributes

Inherited from:
AsObject
Source
Encoder.scala
def decodeAccumulating(c: HCursor): AccumulatingResult[A]

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 decodeProduct(c: HCursor, fromProduct: Product => A): Result[A]

Attributes

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

Attributes

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

Attributes

Inherited from:
ConfiguredDecoder
Source
ConfiguredDecoder.scala
final def decodeSumAccumulating(c: HCursor): AccumulatingResult[A]

Attributes

Inherited from:
ConfiguredDecoder
Source
ConfiguredDecoder.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.

Value parameters

f

a function returning either a value or an error message

Attributes

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.

Value parameters

f

a function returning either a value or an error message

Attributes

Inherited from:
Decoder
Source
Decoder.scala
final def encodeElemAt(index: Int, elem: Any, transformName: String => String): (String, Json)

Attributes

Inherited from:
ConfiguredEncoder
Source
ConfiguredEncoder.scala
def encodeObject(a: A): JsonObject

Convert a value to a JSON object.

Convert a value to a JSON object.

Attributes

Inherited from:
AsObject
Source
Encoder.scala
final def encodeProduct(a: A): JsonObject

Attributes

Inherited from:
ConfiguredEncoder
Source
ConfiguredEncoder.scala
final def encodeSum(index: Int, a: A): JsonObject

Attributes

Inherited from:
ConfiguredEncoder
Source
ConfiguredEncoder.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
final def handleErrorWith(f: DecodingFailure => Decoder[A]): Decoder[A]

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
def iemap[B](f: A => Either[String, B])(g: B => A): Codec[B]

Variant of imap which allows the Decoder to fail with message string.

Variant of imap which allows the Decoder to fail with message string.

Type parameters

B

the type of the new Codec

Value parameters

f

decode value or fail

g

encode value

Attributes

Returns

a codec for B

Inherited from:
Codec
Source
Codec.scala
def iemapTry[B](f: A => Try[B])(g: B => A): Codec[B]

Variant of imap which allows the Decoder to fail with Throwable.

Variant of imap which allows the Decoder to fail with Throwable.

Type parameters

B

the type of the new Codec

Value parameters

f

decode value or fail

g

encode value

Attributes

Returns

a codec for B

Inherited from:
Codec
Source
Codec.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 mapJson(f: Json => Json): Encoder[A]

Create a new Encoder by applying a function to the output of this one.

Create a new Encoder by applying a function to the output of this one.

Attributes

Inherited from:
Encoder
Source
Encoder.scala
final def mapJsonObject(f: JsonObject => JsonObject): AsObject[A]

Create a new Encoder.AsObject by applying a function to the output of this one.

Create a new Encoder.AsObject by applying a function to the output of this one.

Attributes

Inherited from:
AsObject
Source
Encoder.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
def tryDecode(c: ACursor): Result[A]

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
def tryDecodeAccumulating(c: ACursor): AccumulatingResult[A]

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

Inherited fields

lazy val constructorNames: List[String]

Attributes

Inherited from:
ConfiguredDecoder
Source
ConfiguredDecoder.scala
lazy val elemDecoders: List[Decoder[_]]

Attributes

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

Attributes

Inherited from:
ConfiguredDecoder
Source
ConfiguredDecoder.scala
lazy val elemEncoders: List[Encoder[_]]

Attributes

Inherited from:
ConfiguredEncoder
Source
ConfiguredEncoder.scala
lazy val elemLabels: List[String]

Attributes

Inherited from:
ConfiguredEncoder
Source
ConfiguredEncoder.scala
val name: String

Attributes

Inherited from:
ConfiguredDecoder
Source
ConfiguredDecoder.scala
Generated with