Object/Trait

io.circe

Decoder

Related Docs: trait Decoder | package circe

Permalink

object Decoder extends TupleDecoders with LowPriorityDecoders with Serializable

Utilities and instances for Decoder.

Linear Supertypes
Serializable, Serializable, LowPriorityDecoders, fresh$macro$1, TupleDecoders, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Decoder
  2. Serializable
  3. Serializable
  4. LowPriorityDecoders
  5. fresh$macro$1
  6. TupleDecoders
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. type Result[A] = Xor[DecodingFailure, A]

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def apply[A](implicit d: Decoder[A]): Decoder[A]

    Permalink

    Return an instance for a given type.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. implicit val decodeBigDecimal: Decoder[BigDecimal]

    Permalink

  8. implicit val decodeBigInt: Decoder[BigInt]

    Permalink

  9. implicit val decodeBoolean: Decoder[Boolean]

    Permalink

  10. implicit val decodeByte: Decoder[Byte]

    Permalink

  11. implicit def decodeCanBuildFrom[A, C[_]](implicit d: Decoder[A], cbf: CanBuildFrom[Nothing, A, C[A]]): Decoder[C[A]]

    Permalink

  12. implicit val decodeChar: Decoder[Char]

    Permalink

  13. implicit val decodeDouble: Decoder[Double]

    Permalink

  14. def decodeEither[A, B](leftKey: String, rightKey: String)(implicit da: Decoder[A], db: Decoder[B]): Decoder[Either[A, B]]

    Permalink

  15. implicit val decodeFloat: Decoder[Float]

    Permalink

  16. implicit val decodeHCursor: Decoder[HCursor]

    Permalink

  17. implicit val decodeInt: Decoder[Int]

    Permalink

  18. implicit val decodeJson: Decoder[Json]

    Permalink

  19. implicit val decodeJsonNumber: Decoder[JsonNumber]

    Permalink

  20. implicit val decodeJsonObject: Decoder[JsonObject]

    Permalink

  21. implicit val decodeLong: Decoder[Long]

    Permalink

  22. implicit def decodeMap[M[K, +V] <: Map[K, V], V](implicit d: Decoder[V], cbf: CanBuildFrom[Nothing, (String, V), M[String, V]]): Decoder[M[String, V]]

    Permalink

  23. implicit def decodeNonEmptyList[A](implicit arg0: Decoder[A]): Decoder[NonEmptyList[A]]

    Permalink

  24. implicit def decodeOption[A](implicit d: Decoder[A]): Decoder[Option[A]]

    Permalink

  25. implicit def decodeSet[A](implicit arg0: Decoder[A]): Decoder[Set[A]]

    Permalink

  26. implicit val decodeShort: Decoder[Short]

    Permalink

  27. implicit val decodeString: Decoder[String]

    Permalink

  28. implicit def decodeTuple1[A0](implicit decodeA0: Decoder[A0]): Decoder[(A0)]

    Permalink

    Definition Classes
    TupleDecoders

  29. implicit def decodeTuple10[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4], decodeA5: Decoder[A5], decodeA6: Decoder[A6], decodeA7: Decoder[A7], decodeA8: Decoder[A8], decodeA9: Decoder[A9]): Decoder[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9)]

    Permalink

    Definition Classes
    TupleDecoders

  30. implicit def decodeTuple11[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4], decodeA5: Decoder[A5], decodeA6: Decoder[A6], decodeA7: Decoder[A7], decodeA8: Decoder[A8], decodeA9: Decoder[A9], decodeA10: Decoder[A10]): Decoder[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10)]

    Permalink

    Definition Classes
    TupleDecoders

  31. implicit def decodeTuple12[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4], decodeA5: Decoder[A5], decodeA6: Decoder[A6], decodeA7: Decoder[A7], decodeA8: Decoder[A8], decodeA9: Decoder[A9], decodeA10: Decoder[A10], decodeA11: Decoder[A11]): Decoder[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11)]

    Permalink

    Definition Classes
    TupleDecoders

  32. implicit def decodeTuple13[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4], decodeA5: Decoder[A5], decodeA6: Decoder[A6], decodeA7: Decoder[A7], decodeA8: Decoder[A8], decodeA9: Decoder[A9], decodeA10: Decoder[A10], decodeA11: Decoder[A11], decodeA12: Decoder[A12]): Decoder[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12)]

    Permalink

    Definition Classes
    TupleDecoders

  33. implicit def decodeTuple14[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4], decodeA5: Decoder[A5], decodeA6: Decoder[A6], decodeA7: Decoder[A7], decodeA8: Decoder[A8], decodeA9: Decoder[A9], decodeA10: Decoder[A10], decodeA11: Decoder[A11], decodeA12: Decoder[A12], decodeA13: Decoder[A13]): Decoder[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13)]

    Permalink

    Definition Classes
    TupleDecoders

  34. implicit def decodeTuple15[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4], decodeA5: Decoder[A5], decodeA6: Decoder[A6], decodeA7: Decoder[A7], decodeA8: Decoder[A8], decodeA9: Decoder[A9], decodeA10: Decoder[A10], decodeA11: Decoder[A11], decodeA12: Decoder[A12], decodeA13: Decoder[A13], decodeA14: Decoder[A14]): Decoder[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14)]

    Permalink

    Definition Classes
    TupleDecoders

  35. implicit def decodeTuple16[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4], decodeA5: Decoder[A5], decodeA6: Decoder[A6], decodeA7: Decoder[A7], decodeA8: Decoder[A8], decodeA9: Decoder[A9], decodeA10: Decoder[A10], decodeA11: Decoder[A11], decodeA12: Decoder[A12], decodeA13: Decoder[A13], decodeA14: Decoder[A14], decodeA15: Decoder[A15]): Decoder[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15)]

    Permalink

    Definition Classes
    TupleDecoders

  36. implicit def decodeTuple17[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4], decodeA5: Decoder[A5], decodeA6: Decoder[A6], decodeA7: Decoder[A7], decodeA8: Decoder[A8], decodeA9: Decoder[A9], decodeA10: Decoder[A10], decodeA11: Decoder[A11], decodeA12: Decoder[A12], decodeA13: Decoder[A13], decodeA14: Decoder[A14], decodeA15: Decoder[A15], decodeA16: Decoder[A16]): Decoder[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16)]

    Permalink

    Definition Classes
    TupleDecoders

  37. implicit def decodeTuple18[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4], decodeA5: Decoder[A5], decodeA6: Decoder[A6], decodeA7: Decoder[A7], decodeA8: Decoder[A8], decodeA9: Decoder[A9], decodeA10: Decoder[A10], decodeA11: Decoder[A11], decodeA12: Decoder[A12], decodeA13: Decoder[A13], decodeA14: Decoder[A14], decodeA15: Decoder[A15], decodeA16: Decoder[A16], decodeA17: Decoder[A17]): Decoder[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17)]

    Permalink

    Definition Classes
    TupleDecoders

  38. implicit def decodeTuple19[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4], decodeA5: Decoder[A5], decodeA6: Decoder[A6], decodeA7: Decoder[A7], decodeA8: Decoder[A8], decodeA9: Decoder[A9], decodeA10: Decoder[A10], decodeA11: Decoder[A11], decodeA12: Decoder[A12], decodeA13: Decoder[A13], decodeA14: Decoder[A14], decodeA15: Decoder[A15], decodeA16: Decoder[A16], decodeA17: Decoder[A17], decodeA18: Decoder[A18]): Decoder[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18)]

    Permalink

    Definition Classes
    TupleDecoders

  39. implicit def decodeTuple2[A0, A1](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1]): Decoder[(A0, A1)]

    Permalink

    Definition Classes
    TupleDecoders

  40. implicit def decodeTuple20[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4], decodeA5: Decoder[A5], decodeA6: Decoder[A6], decodeA7: Decoder[A7], decodeA8: Decoder[A8], decodeA9: Decoder[A9], decodeA10: Decoder[A10], decodeA11: Decoder[A11], decodeA12: Decoder[A12], decodeA13: Decoder[A13], decodeA14: Decoder[A14], decodeA15: Decoder[A15], decodeA16: Decoder[A16], decodeA17: Decoder[A17], decodeA18: Decoder[A18], decodeA19: Decoder[A19]): Decoder[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19)]

    Permalink

    Definition Classes
    TupleDecoders

  41. implicit def decodeTuple21[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4], decodeA5: Decoder[A5], decodeA6: Decoder[A6], decodeA7: Decoder[A7], decodeA8: Decoder[A8], decodeA9: Decoder[A9], decodeA10: Decoder[A10], decodeA11: Decoder[A11], decodeA12: Decoder[A12], decodeA13: Decoder[A13], decodeA14: Decoder[A14], decodeA15: Decoder[A15], decodeA16: Decoder[A16], decodeA17: Decoder[A17], decodeA18: Decoder[A18], decodeA19: Decoder[A19], decodeA20: Decoder[A20]): Decoder[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20)]

    Permalink

    Definition Classes
    TupleDecoders

  42. implicit def decodeTuple22[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4], decodeA5: Decoder[A5], decodeA6: Decoder[A6], decodeA7: Decoder[A7], decodeA8: Decoder[A8], decodeA9: Decoder[A9], decodeA10: Decoder[A10], decodeA11: Decoder[A11], decodeA12: Decoder[A12], decodeA13: Decoder[A13], decodeA14: Decoder[A14], decodeA15: Decoder[A15], decodeA16: Decoder[A16], decodeA17: Decoder[A17], decodeA18: Decoder[A18], decodeA19: Decoder[A19], decodeA20: Decoder[A20], decodeA21: Decoder[A21]): Decoder[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21)]

    Permalink

    Definition Classes
    TupleDecoders

  43. implicit def decodeTuple3[A0, A1, A2](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2]): Decoder[(A0, A1, A2)]

    Permalink

    Definition Classes
    TupleDecoders

  44. implicit def decodeTuple4[A0, A1, A2, A3](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3]): Decoder[(A0, A1, A2, A3)]

    Permalink

    Definition Classes
    TupleDecoders

  45. implicit def decodeTuple5[A0, A1, A2, A3, A4](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4]): Decoder[(A0, A1, A2, A3, A4)]

    Permalink

    Definition Classes
    TupleDecoders

  46. implicit def decodeTuple6[A0, A1, A2, A3, A4, A5](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4], decodeA5: Decoder[A5]): Decoder[(A0, A1, A2, A3, A4, A5)]

    Permalink

    Definition Classes
    TupleDecoders

  47. implicit def decodeTuple7[A0, A1, A2, A3, A4, A5, A6](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4], decodeA5: Decoder[A5], decodeA6: Decoder[A6]): Decoder[(A0, A1, A2, A3, A4, A5, A6)]

    Permalink

    Definition Classes
    TupleDecoders

  48. implicit def decodeTuple8[A0, A1, A2, A3, A4, A5, A6, A7](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4], decodeA5: Decoder[A5], decodeA6: Decoder[A6], decodeA7: Decoder[A7]): Decoder[(A0, A1, A2, A3, A4, A5, A6, A7)]

    Permalink

    Definition Classes
    TupleDecoders

  49. implicit def decodeTuple9[A0, A1, A2, A3, A4, A5, A6, A7, A8](implicit decodeA0: Decoder[A0], decodeA1: Decoder[A1], decodeA2: Decoder[A2], decodeA3: Decoder[A3], decodeA4: Decoder[A4], decodeA5: Decoder[A5], decodeA6: Decoder[A6], decodeA7: Decoder[A7], decodeA8: Decoder[A8]): Decoder[(A0, A1, A2, A3, A4, A5, A6, A7, A8)]

    Permalink

    Definition Classes
    TupleDecoders

  50. implicit val decodeUUID: Decoder[UUID]

    Permalink

  51. implicit val decodeUnit: Decoder[Unit]

    Permalink

  52. def decodeValidated[E, A](failureKey: String, successKey: String)(implicit de: Decoder[E], da: Decoder[A]): Decoder[Validated[E, A]]

    Permalink

  53. def decodeXor[A, B](leftKey: String, rightKey: String)(implicit da: Decoder[A], db: Decoder[B]): Decoder[Xor[A, B]]

    Permalink

  54. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  55. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  56. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  57. implicit macro def fresh$macro$2[fresh$macro$3]: Decoder[fresh$macro$3]

    Permalink
    Definition Classes
    LowPriorityDecoders

  58. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  59. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  60. def instance[A](f: (HCursor) ⇒ Result[A]): Decoder[A]

    Permalink

    Construct an instance from a function.

  61. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  62. implicit val monadDecode: Monad[Decoder]

    Permalink

  63. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  64. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  65. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  66. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  67. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  68. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  69. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  70. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  71. def withReattempt[A](f: (ACursor) ⇒ Result[A]): Decoder[A]

    Permalink

    Construct an instance from a function that will reattempt on failure.

Inherited from Serializable

Inherited from Serializable

Inherited from LowPriorityDecoders

Inherited from fresh$macro$1

Inherited from TupleDecoders

Inherited from AnyRef

Inherited from Any

Miscellaneous utilities

Decoder instances

Disjunction instances

Instance creation methods for disjunction-like types. Note that these instances are implicit, since they require non-obvious decisions about the names of the discriminators. If you want instances for these types you can include the following import in your program:

import io.circe.disjunctionCodecs._

Type class instances

Tuple instances

Ungrouped