io.circe

Decoder

trait Decoder[A] extends Serializable

Self Type
Decoder[A]
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Decoder
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def apply(c: HCursor): Result[A]

    Decode the given hcursor.

Concrete Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def accumulating: AccumulatingDecoder[A]

  7. final def and[B](fb: Decoder[B]): Decoder[(A, B)]

    Run two decoders and return their results as a pair.

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def decodeJson(j: Json): Result[A]

    Decode the given Json value.

  11. final def emap[B](f: (A) ⇒ Xor[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.

    f

    a function returning either a value or an error message

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

    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def flatMap[B](f: (A) ⇒ Decoder[B]): Decoder[B]

    Monadically bind a function over this Decoder.

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

    Definition Classes
    AnyRef → Any
  17. 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.

  18. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  20. final def kleisli: Kleisli[Result, HCursor, A]

    Convert to a Kleisli arrow.

  21. final def map[B](f: (A) ⇒ B): Decoder[B]

    Map a function over this Decoder.

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

    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  25. final def or[AA >: A](d: ⇒ Decoder[AA]): Decoder[AA]

    Choose the first succeeding decoder.

  26. final def prepare(f: (HCursor) ⇒ ACursor): Decoder[A]

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

  27. final def product[B](x: Decoder[B]): (HCursor, HCursor) ⇒ Result[(A, B)]

    Run two decoders.

  28. final def split[B](d: Decoder[B]): (Xor[HCursor, HCursor]) ⇒ Result[Xor[A, B]]

    Run one or another decoder.

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

    Definition Classes
    AnyRef
  30. def toString(): String

    Definition Classes
    AnyRef → Any
  31. def tryDecode(c: ACursor): Result[A]

    Decode the given acursor.

  32. def tryDecodeAccumulating(c: ACursor): Result[A]

  33. final def validate(pred: (HCursor) ⇒ Boolean, message: ⇒ String): Decoder[A]

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

  34. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def withErrorMessage(message: String): Decoder[A]

    Build a new instance with the specified error message.

Deprecated Value Members

  1. final def ap[B](f: Decoder[(A) ⇒ B]): Decoder[B]

    Annotations
    @deprecated
    Deprecated

    (Since version 0.4.0) Use and

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped