Decoder

Abstract Value Members

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

Decode the given HCursor.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Decode the given Json value.
final def either[B](decodeB: Decoder[B]): Decoder[Either[A, B]]

Choose the first succeeding decoder, wrapping the result in a disjunction.
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
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
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.
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.
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Monadically bind a function over this Decoder.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
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.
def hashCode(): Int

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

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

Convert to a Kleisli arrow.
final def map[B](f: (A) ⇒ B): Decoder[B]

Map a function over this Decoder.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Choose the first succeeding decoder.
final def prepare(f: (ACursor) ⇒ ACursor): Decoder[A]

Create a new decoder that performs some operation on the incoming JSON before decoding.
final def product[B](fb: Decoder[B]): Decoder[(A, B)]

Run two decoders and return their results as a pair.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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.
def tryDecodeAccumulating(c: ACursor): AccumulatingResult[A]
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).
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).
final def wait(): Unit

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

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

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

Build a new instance with the specified error message.

Deprecated Value Members

final def accumulating(c: HCursor): AccumulatingResult[A]

Annotations
@deprecated
Deprecated
(Since version 0.12.0) Use decodeAccumulating

Related Docs: object Decoder | package circe

trait Decoder[A] extends Serializable

Abstract Value Members

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

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def decodeAccumulating(c: HCursor): AccumulatingResult[A]

final def decodeJson(j: Json): Result[A]

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

final def emap[B](f: (A) ⇒ Either[String, B]): Decoder[B]

final def emapTry[B](f: (A) ⇒ Try[B]): Decoder[B]

final def ensure(errors: (A) ⇒ List[String]): Decoder[A]

final def ensure(pred: (A) ⇒ Boolean, message: ⇒ String): Decoder[A]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def flatMap[B](f: (A) ⇒ Decoder[B]): Decoder[B]

final def getClass(): Class[_]

final def handleErrorWith(f: (DecodingFailure) ⇒ Decoder[A]): Decoder[A]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def kleisli: Kleisli[Result, HCursor, A]

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def or[AA >: A](d: ⇒ Decoder[AA]): Decoder[AA]

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

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

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

def toString(): String

def tryDecode(c: ACursor): Result[A]

def tryDecodeAccumulating(c: ACursor): AccumulatingResult[A]

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

final def validate(errors: (HCursor) ⇒ List[String]): Decoder[A]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

final def withErrorMessage(message: String): Decoder[A]

Deprecated Value Members

final def accumulating(c: HCursor): AccumulatingResult[A]

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped