Instance

Instance Constructors

new Instance(run: (A) ⇒ Either[DecodeError, B])

run
the backing function

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 and[C](that: Decoder[A, C]): Decoder[A, (B, C)]

Construct a new decoder by joining this decoder with another, tupling the results.
Construct a new decoder by joining this decoder with another, tupling the results. Errors accumulate.

Definition Classes
Decoder
final def andThen[C](next: Decoder[B, C]): Decoder[A, C]

Construct a new decoder by using the output of this decoder as the input of another
Construct a new decoder by using the output of this decoder as the input of another

Definition Classes
Decoder
def apply(a: A): Either[DecodeError, B]

Decode a value of type A as type B
Decode a value of type A as type B

Definition Classes
Instance → Decoder
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def atPath(path: String)(implicit read: Read[A, A]): Decoder[A, B]

Construct a new decoder that first reads a path.
Construct a new decoder that first reads a path. The value read is then passed to this decoder. Errors are adjusted to reflect that they occurred at a nested path.

Definition Classes
Decoder
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def compose[Z](previous: Decoder[Z, A]): Decoder[Z, B]

Construct a new decoder by using the result of another decoder as the input to this decoder
Construct a new decoder by using the result of another decoder as the input to this decoder

Definition Classes
Decoder
final def decode(a: A): Either[DecodeError, B]

Decode a value of type A as type B.
Decode a value of type A as type B.
This is an alias for apply.

Definition Classes
Decoder
final def deepOptional: Decoder[A, Option[B]]

Constructs a new decoder that optionally decodes a value.
Constructs a new decoder that optionally decodes a value. Deep errors other than a missing value still cause the resulting decoder to fail.

Definition Classes
Decoder
See also
DecodeError.AtPath.deepError
final def emap[C](f: (B) ⇒ Either[DecodeError, C]): Decoder[A, C]

Construct a new decoder by mapping the output of this decoder to either a DecodeError or a new result type
Construct a new decoder by mapping the output of this decoder to either a DecodeError or a new result type

Definition Classes
Decoder
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

Construct a new decoder through a monadic bind
Construct a new decoder through a monadic bind

Definition Classes
Decoder
final def getClass(): Class[_]

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

Definition Classes
Any
final def join[C](that: Decoder[A, C]): Decoder[A, (B, C)]

[use case] Construct a new decoder by joining this decoder with another, tupling the results.
[use case]
Construct a new decoder by joining this decoder with another, tupling the results. Errors accumulate.
This behaves similar to and except that instead of always returning a nested tuple it attempts to return a flattened tuple.

Definition Classes
Decoder
Full Signature
final def join[C](that: Decoder[A, C])(implicit j: Join[B, C]): Decoder[A, Out]
final def leftMap(f: (DecodeError) ⇒ DecodeError): Decoder[A, B]

Construct a new decoder by mapping the error output of this decoder to a new error
Construct a new decoder by mapping the error output of this decoder to a new error

Definition Classes
Decoder
final def map[C](f: (B) ⇒ C): Decoder[A, C]

Construct a new decoder by mapping the output of this decoder
Construct a new decoder by mapping the output of this decoder

Definition Classes
Decoder
final def mapInput[Z](f: (Z) ⇒ A): Decoder[Z, B]

Construct a new decoder by mapping the input to this decoder
Construct a new decoder by mapping the input to this decoder

Definition Classes
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 optional: Decoder[A, Option[B]]

Constructs a new decoder that optionally decodes a value.
Constructs a new decoder that optionally decodes a value. Errors other than a missing value still cause the resulting decoder to fail.

Definition Classes
Decoder
final def or[BB >: B](that: Decoder[A, BB]): Decoder[A, BB]

Construct a new decoder using this decoder first.
Construct a new decoder using this decoder first. If it fails, use the other. Errors accumulate.

Definition Classes
Decoder
val run: (A) ⇒ Either[DecodeError, B]

the backing function
final def sequence[F[_]](implicit Ft: Traversable[F], Fi: Indexed[F]): Decoder[F[A], F[B]]

Constructs a new decoder that decodes a sequence of inputs.
Constructs a new decoder that decodes a sequence of inputs. The result is sequenced so that any errors cause the overall decoder to fail. Errors accumulate and are marked with their index if they fail.

Definition Classes
Decoder
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def trace(prefix: String = "> "): Decoder[A, B]

Construct a new decoder that traces the result to stdout
Construct a new decoder that traces the result to stdout

Definition Classes
Decoder
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 withDeepDefault(default: B): Decoder[A, B]

Constructs a new decoder that falls back to a default value if a deep missing value error occurs.
Constructs a new decoder that falls back to a default value if a deep missing value error occurs.

Definition Classes
Decoder
See also
DecodeError.AtPath.deepError
final def withDefault(default: B): Decoder[A, B]

Constructs a new decoder that falls back to a default value if a missing value error occurs.
Constructs a new decoder that falls back to a default value if a missing value error occurs.

Definition Classes
Decoder
final def withFallback(fallback: B): Decoder[A, B]

Constructs a new decoder that falls back to a value if _any_ error occurs.
Constructs a new decoder that falls back to a value if _any_ error occurs.
To provide default values for a decoder, consider using withDefault.

Definition Classes
Decoder

Related Doc: package Decoder

final case class Instance[A, B](run: (A) ⇒ Either[DecodeError, B]) extends Decoder[A, B] with Product with Serializable

Instance Constructors

new Instance(run: (A) ⇒ Either[DecodeError, B])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def and[C](that: Decoder[A, C]): Decoder[A, (B, C)]

final def andThen[C](next: Decoder[B, C]): Decoder[A, C]

def apply(a: A): Either[DecodeError, B]

final def asInstanceOf[T0]: T0

final def atPath(path: String)(implicit read: Read[A, A]): Decoder[A, B]

def clone(): AnyRef

final def compose[Z](previous: Decoder[Z, A]): Decoder[Z, B]

final def decode(a: A): Either[DecodeError, B]

final def deepOptional: Decoder[A, Option[B]]

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

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

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

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def join[C](that: Decoder[A, C]): Decoder[A, (B, C)]

final def join[C](that: Decoder[A, C])(implicit j: Join[B, C]): Decoder[A, Out]

final def leftMap(f: (DecodeError) ⇒ DecodeError): Decoder[A, B]

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

final def mapInput[Z](f: (Z) ⇒ A): Decoder[Z, B]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def optional: Decoder[A, Option[B]]

final def or[BB >: B](that: Decoder[A, BB]): Decoder[A, BB]

val run: (A) ⇒ Either[DecodeError, B]

final def sequence[F[_]](implicit Ft: Traversable[F], Fi: Indexed[F]): Decoder[F[A], F[B]]

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

final def trace(prefix: String = "> "): Decoder[A, B]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

final def withDeepDefault(default: B): Decoder[A, B]

final def withDefault(default: B): Decoder[A, B]

final def withFallback(fallback: B): Decoder[A, B]

Inherited from Product

Inherited from Equals

Inherited from Decoder[A, B]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped