Packages

trait Decoder[A] extends Serializable

A type class that provides a way to produce a value of type A from a Json value.

Self Type
Decoder[A]
Linear Supertypes
Serializable, AnyRef, Any
Known Subclasses
Codec, AsArray, AsObject, AsRoot
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Decoder
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
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: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. final def at(field: String): Decoder[A]

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

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def decodeAccumulating(c: HCursor): AccumulatingResult[A]
  8. final def decodeJson(j: Json): Result[A]

    Decode the given Json value.

  9. final def either[B](decodeB: Decoder[B]): Decoder[Either[A, B]]

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

  10. 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.

    f

    a function returning either a value or an error message

  11. 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.

    f

    a function returning either a value or an error message

  12. 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.

  13. 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.

  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def flatMap[B](f: (A) ⇒ Decoder[B]): Decoder[B]

    Monadically bind a function over this Decoder.

  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. 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.

  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def kleisli: Kleisli[Result, HCursor, A]

    Convert to a Kleisli arrow.

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

    Map a function over this Decoder.

  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def or[AA >: A](d: ⇒ Decoder[AA]): Decoder[AA]

    Choose the first succeeding decoder.

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

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

  29. final def product[B](fb: Decoder[B]): Decoder[(A, B)]

    Run two decoders and return their results as a pair.

  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. 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.

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

    Note that this condition is checked before decoding with the current decoder, and if it does not hold, decoding does not continue. This means that if you chain calls to this method, errors will not be accumulated (instead only the error of the last failing validate in the chain will be returned).

  35. 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.

    Note that this condition is checked before decoding with the current decoder, and if it does not hold, decoding does not continue. This means that if you chain calls to this method, errors will not be accumulated (instead only the error of the last failing validate in the chain will be returned).

  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def withErrorMessage(message: String): Decoder[A]

    Build a new instance with the specified error message.

Deprecated Value Members

  1. final def accumulating(c: HCursor): AccumulatingResult[A]
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Use decodeAccumulating

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped