OptionDecoder
A decoder for Option[A]
.
This is modeled as a separate, named, subtype because Option decoders
often have special semantics around the handling of JNull
. By having
this as a named subtype, we premit certain optimizations that would
otherwise not be possible. See circe-generic-extras
for some examples.
Attributes
- Source:
- Decoder.scala
- Graph
- Supertypes
Members list
Value members
Concrete methods
Decode the given HCursor.
Attributes
- Definition Classes
- 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
- Definition Classes
- Source:
- Decoder.scala
Attributes
- Definition Classes
- Source:
- Decoder.scala
Inherited methods
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
Decode the given Json value.
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
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
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
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
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
Monadically bind a function over this Decoder.
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
Convert to a Kleisli arrow.
Map a function over this Decoder.
Choose the first succeeding decoder.
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
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
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
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
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