DecodeError

Type Members

sealed abstract class AggregateError extends DecodeError

An aggregation of multiple child errors that ocurred
final case class And(head: DecodeError, tail: List[DecodeError]) extends AggregateError with Product with Serializable

A conjunction of child errors.
A conjunction of child errors.
All child errors must be resolved for decoding to succeed.
final case class AtIndex(index: Int, error: DecodeError) extends DecodeError with Product with Serializable

Qualifies a nested error indicating that it occurred while decoding a particular index within the source traversable data structure
final case class AtPath(path: String, error: DecodeError) extends DecodeError with Product with Serializable

Qualifies a nested error indicating that it occured while decoding a particular path within the source data structure
sealed trait LeafDecodeError extends DecodeError

A marker for decode errors that don't have any child errors
final case class Or(head: DecodeError, tail: List[DecodeError]) extends AggregateError with Product with Serializable

A disjunction of child errors.
A disjunction of child errors.
One child error must be resolved for decoding to succeed.
final case class Truncated(raw: String, result: String) extends DecodeError with LeafDecodeError with Product with Serializable

A value was present and decoded but was truncated during the decoding process.
A value was present and decoded but was truncated during the decoding process.
This error typically occurs when strict decoding is used against a backend implementation that normally defaults to lossy decoding that truncates values (generally numeric).
final case class Underlying(underlying: Throwable) extends DecodeError with LeafDecodeError with Product with Serializable

Indicates that an underlying (and generally unexpected) error occurred while interacting with the source data structure.
Indicates that an underlying (and generally unexpected) error occurred while interacting with the source data structure.
This typically shouldn't happen and this error may be removed in future releases.
final case class WrongType(expected: String, got: Option[String] = None) extends DecodeError with LeafDecodeError with Product with Serializable

A value was present but was the type was incorrect

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
object And extends Serializable
object Missing extends DecodeError with LeafDecodeError with Product with Serializable

A value was required but not found in the source data structure
object Or extends Serializable
def and(a: DecodeError, b: DecodeError): DecodeError

Create a conjunction of errors.
Create a conjunction of errors.
If either error is already a conjunction then the contents are unfolded before returning a single "flattened" result.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
implicit def eitherDecodeErrorApplicative: Applicative[[β$0$]Either[DecodeError, β$0$]]

Definition Classes
DecodeErrorInstances
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 getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def or(a: DecodeError, b: DecodeError): DecodeError

Create a disjunction of errors.
Create a disjunction of errors.
If either error is already a disjunction then the contents are unfolded before returning a single "flattened" result.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

Related Docs: class DecodeError | package core

object DecodeError extends DecodeErrorInstances with Serializable

Type Members

sealed abstract class AggregateError extends DecodeError

final case class And(head: DecodeError, tail: List[DecodeError]) extends AggregateError with Product with Serializable

final case class AtIndex(index: Int, error: DecodeError) extends DecodeError with Product with Serializable

final case class AtPath(path: String, error: DecodeError) extends DecodeError with Product with Serializable

sealed trait LeafDecodeError extends DecodeError

final case class Or(head: DecodeError, tail: List[DecodeError]) extends AggregateError with Product with Serializable

final case class Truncated(raw: String, result: String) extends DecodeError with LeafDecodeError with Product with Serializable

final case class Underlying(underlying: Throwable) extends DecodeError with LeafDecodeError with Product with Serializable

final case class WrongType(expected: String, got: Option[String] = None) extends DecodeError with LeafDecodeError with Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object And extends Serializable

object Missing extends DecodeError with LeafDecodeError with Product with Serializable

object Or extends Serializable

def and(a: DecodeError, b: DecodeError): DecodeError

final def asInstanceOf[T0]: T0

def clone(): AnyRef

implicit def eitherDecodeErrorApplicative: Applicative[[β$0$]Either[DecodeError, β$0$]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def or(a: DecodeError, b: DecodeError): DecodeError

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from DecodeErrorInstances

Inherited from AnyRef

Inherited from Any

Ungrouped