Trait/Object

io.circe

Decoder

Related Docs: object Decoder | package circe

Permalink

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
Visibility
  1. Public
  2. All

Abstract Value Members

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

    Permalink

    Decode the given hcursor.

Concrete 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. final def accumulating: AccumulatingDecoder[A]

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

    Permalink

    Run two decoders and return their results as a pair.

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

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

    Permalink

    Decode the given Json value.

  9. final def emap[B](f: (A) ⇒ Xor[String, B]): Decoder[B]

    Permalink

    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

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

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

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

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

    Permalink

    Monadically bind a function over this Decoder.

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

    Permalink
    Definition Classes
    AnyRef → Any
  15. final def handleErrorWith(f: (DecodingFailure) ⇒ Decoder[A]): Decoder[A]

    Permalink

    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.

  16. def hashCode(): Int

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

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

    Permalink

    Convert to a Kleisli arrow.

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

    Permalink

    Map a function over this Decoder.

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

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

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

    Permalink

    Choose the first succeeding decoder.

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

    Permalink

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

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

    Permalink

    Run two decoders.

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

    Permalink

    Run one or another decoder.

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

    Permalink
    Definition Classes
    AnyRef
  28. def toString(): String

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

    Permalink

    Decode the given acursor.

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

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

    Permalink

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

  32. final def wait(): Unit

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

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

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

    Permalink

    Build a new instance with the specified error message.

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped