Decoder

Abstract Value Members

abstract def decode(bits: BitVector): Attempt[DecodeResult[A]]

Attempts to decode a value of type A from the specified bit vector.
Attempts to decode a value of type A from the specified bit vector.
bits
bits to decode
returns
error if value could not be decoded or the remaining bits and the decoded value

Concrete Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from Decoder[A] to any2stringadd[Decoder[A]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (Decoder[A], B)

Implicit information
This member is added by an implicit conversion from Decoder[A] to ArrowAssoc[Decoder[A]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def as[B](implicit as: Transformer[A, B]): Decoder[B]

Transforms using implicitly available evidence that such a transformation is possible.
Transforms using implicitly available evidence that such a transformation is possible.
Typical transformations include converting:
- an F[L] for some L <: HList to/from an F[CC] for some case class CC, where the types in the case class are aligned with the types in L
- an F[C] for some C <: Coproduct to/from an F[SC] for some sealed class SC, where the component types in the coproduct are the leaf subtypes of the sealed class.
Implicit information
This member is added by an implicit conversion from Decoder[A] to TransformSyntax[Decoder, A] performed by method TransformSyntax in scodec.
Definition Classes
TransformSyntax
def asDecoder: Decoder[A]

Gets this as a Decoder.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def complete: Decoder[A]

Converts this decoder to a new decoder that fails decoding if there are remaining bits.
def decodeOnly[AA >: A]: Codec[AA]

Converts this to a codec that fails encoding with an error.
final def decodeValue(bits: BitVector): Attempt[A]

Attempts to decode a value of type A from the specified bit vector and discards the remaining bits.
Attempts to decode a value of type A from the specified bit vector and discards the remaining bits.
bits
bits to decode
returns
error if value could not be decoded or the decoded value
def emap[B](f: (A) ⇒ Attempt[B]): Decoder[B]

Converts this decoder to a Decoder[B] using the supplied A => Attempt[B].
def ensuring(cond: (Decoder[A]) ⇒ Boolean, msg: ⇒ Any): Decoder[A]

Implicit information
This member is added by an implicit conversion from Decoder[A] to Ensuring[Decoder[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Decoder[A]) ⇒ Boolean): Decoder[A]

Implicit information
This member is added by an implicit conversion from Decoder[A] to Ensuring[Decoder[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): Decoder[A]

Implicit information
This member is added by an implicit conversion from Decoder[A] to Ensuring[Decoder[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Decoder[A]

Implicit information
This member is added by an implicit conversion from Decoder[A] to Ensuring[Decoder[A]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def exmap[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ Attempt[A]): Decoder[B]

Transforms using two functions, A => Attempt[B] and B => Attempt[A].
Transforms using two functions, A => Attempt[B] and B => Attempt[A].

Implicit information
This member is added by an implicit conversion from Decoder[A] to TransformSyntax[Decoder, A] performed by method TransformSyntax in scodec.
Definition Classes
TransformSyntax
def exmapc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ Attempt[A]): Decoder[B]

Curried version of exmap.
Curried version of exmap.

Implicit information
This member is added by an implicit conversion from Decoder[A] to TransformSyntax[Decoder, A] performed by method TransformSyntax in scodec.
Definition Classes
TransformSyntax
def finalize(): Unit

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

Converts this decoder to a Decoder[B] using the supplied A => Decoder[B].
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from Decoder[A] to StringFormat[Decoder[A]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
def map[B](f: (A) ⇒ B): Decoder[B]

Converts this decoder to a Decoder[B] using the supplied A => B.
def narrow[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ A): Decoder[B]

Transforms using two functions, A => Attempt[B] and B => A.
Transforms using two functions, A => Attempt[B] and B => A.
The supplied functions form an injection from B to A. Hence, this method converts from a larger to a smaller type. Hence, the name narrow.

Implicit information
This member is added by an implicit conversion from Decoder[A] to TransformSyntax[Decoder, A] performed by method TransformSyntax in scodec.
Definition Classes
TransformSyntax
def narrowc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ A): Decoder[B]

Curried version of narrow.
Curried version of narrow.

Implicit information
This member is added by an implicit conversion from Decoder[A] to TransformSyntax[Decoder, A] performed by method TransformSyntax in scodec.
Definition Classes
TransformSyntax
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def selectDecoder[A](implicit sel: Selector[A, A]): Decoder[Option[A]]

When called on a Decoder[C] where C is a coproduct containing type A, converts to a Decoder[Option[A]].
When called on a Decoder[C] where C is a coproduct containing type A, converts to a Decoder[Option[A]].

Implicit information
This member is added by an implicit conversion from Decoder[A] to EnrichedCoproductDecoder[A] performed by method EnrichedCoproductDecoder in scodec. This conversion will take place only if A is a subclass of Coproduct (A <: Coproduct).
Definition Classes
EnrichedCoproductDecoder
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( ... )
def widen[B](f: (A) ⇒ B, g: (B) ⇒ Attempt[A]): Decoder[B]

Transforms using two functions, A => B and B => Attempt[A].
Transforms using two functions, A => B and B => Attempt[A].
The supplied functions form an injection from A to B. Hence, this method converts from a smaller to a larger type. Hence, the name widen.

Implicit information
This member is added by an implicit conversion from Decoder[A] to TransformSyntax[Decoder, A] performed by method TransformSyntax in scodec.
Definition Classes
TransformSyntax
def widenOpt[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): Decoder[B]

Transforms using two functions, A => B and B => Option[A].
Transforms using two functions, A => B and B => Option[A].
Particularly useful when combined with case class apply/unapply. E.g., widenOpt(fa, Foo.apply, Foo.unapply).

Implicit information
This member is added by an implicit conversion from Decoder[A] to TransformSyntax[Decoder, A] performed by method TransformSyntax in scodec.
Definition Classes
TransformSyntax
def widenOptc[B](f: (A) ⇒ B)(g: (B) ⇒ Option[A]): Decoder[B]

Curried version of widenOpt.
Curried version of widenOpt.

Implicit information
This member is added by an implicit conversion from Decoder[A] to TransformSyntax[Decoder, A] performed by method TransformSyntax in scodec.
Definition Classes
TransformSyntax
def widenc[B](f: (A) ⇒ B)(g: (B) ⇒ Attempt[A]): Decoder[B]

Curried version of widen.
Curried version of widen.

Implicit information
This member is added by an implicit conversion from Decoder[A] to TransformSyntax[Decoder, A] performed by method TransformSyntax in scodec.
Definition Classes
TransformSyntax
def xmap[B](f: (A) ⇒ B, g: (B) ⇒ A): Decoder[B]

Transforms using the isomorphism described by two functions, A => B and B => A.
Transforms using the isomorphism described by two functions, A => B and B => A.

Implicit information
This member is added by an implicit conversion from Decoder[A] to TransformSyntax[Decoder, A] performed by method TransformSyntax in scodec.
Definition Classes
TransformSyntax
def xmapc[B](f: (A) ⇒ B)(g: (B) ⇒ A): Decoder[B]

Curried version of xmap.
Curried version of xmap.

Implicit information
This member is added by an implicit conversion from Decoder[A] to TransformSyntax[Decoder, A] performed by method TransformSyntax in scodec.
Definition Classes
TransformSyntax
def →[B](y: B): (Decoder[A], B)

Implicit information
This member is added by an implicit conversion from Decoder[A] to ArrowAssoc[Decoder[A]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Shadowed Implicit Value Members

val self: Decoder[A]
Implicit information
This member is added by an implicit conversion from Decoder[A] to EnrichedCoproductDecoder[A] performed by method EnrichedCoproductDecoder in scodec. This conversion will take place only if A is a subclass of Coproduct (A <: Coproduct).
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(decoder: EnrichedCoproductDecoder[A]).self
Definition Classes
EnrichedCoproductDecoder
val self: Decoder[A]

Supports TransformSyntax.
Supports TransformSyntax.
Implicit information
This member is added by an implicit conversion from Decoder[A] to TransformSyntax[Decoder, A] performed by method TransformSyntax in scodec.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(decoder: TransformSyntax[Decoder, A]).self
Definition Classes
TransformSyntax

Deprecated Value Members

def pxmap[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): Decoder[B]

Transforms using two functions, A => B and B => Option[A].
Transforms using two functions, A => B and B => Option[A].
Particularly useful when combined with case class apply/unapply. E.g., pxmap(fa, Foo.apply, Foo.unapply).

Implicit information
This member is added by an implicit conversion from Decoder[A] to TransformSyntax[Decoder, A] performed by method TransformSyntax in scodec.
Definition Classes
TransformSyntax
Annotations
@deprecated
Deprecated
(Since version 1.7.0) Use widenOpt instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion EnrichedCoproductDecoder from Decoder[A] to EnrichedCoproductDecoder[A]

Inherited by implicit conversion TransformSyntax from Decoder[A] to TransformSyntax[Decoder, A]

Inherited by implicit conversion any2stringadd from Decoder[A] to any2stringadd[Decoder[A]]

Inherited by implicit conversion StringFormat from Decoder[A] to StringFormat[Decoder[A]]

Inherited by implicit conversion Ensuring from Decoder[A] to Ensuring[Decoder[A]]

Inherited by implicit conversion ArrowAssoc from Decoder[A] to ArrowAssoc[Decoder[A]]

Primary Members

Basic Combinators

Coproduct Support

Ungrouped

Related Docs: object Decoder | package scodec

trait Decoder[+A] extends AnyRef

Abstract Value Members

abstract def decode(bits: BitVector): Attempt[DecodeResult[A]]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (Decoder[A], B)

final def ==(arg0: Any): Boolean

def as[B](implicit as: Transformer[A, B]): Decoder[B]

def asDecoder: Decoder[A]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def complete: Decoder[A]

def decodeOnly[AA >: A]: Codec[AA]

final def decodeValue(bits: BitVector): Attempt[A]

def emap[B](f: (A) ⇒ Attempt[B]): Decoder[B]

def ensuring(cond: (Decoder[A]) ⇒ Boolean, msg: ⇒ Any): Decoder[A]

def ensuring(cond: (Decoder[A]) ⇒ Boolean): Decoder[A]

def ensuring(cond: Boolean, msg: ⇒ Any): Decoder[A]

def ensuring(cond: Boolean): Decoder[A]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def exmap[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ Attempt[A]): Decoder[B]

def exmapc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ Attempt[A]): Decoder[B]

def finalize(): Unit

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

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

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

def narrow[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ A): Decoder[B]

def narrowc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ A): Decoder[B]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def selectDecoder[A](implicit sel: Selector[A, A]): Decoder[Option[A]]

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

def widen[B](f: (A) ⇒ B, g: (B) ⇒ Attempt[A]): Decoder[B]

def widenOpt[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): Decoder[B]

def widenOptc[B](f: (A) ⇒ B)(g: (B) ⇒ Option[A]): Decoder[B]

def widenc[B](f: (A) ⇒ B)(g: (B) ⇒ Attempt[A]): Decoder[B]

def xmap[B](f: (A) ⇒ B, g: (B) ⇒ A): Decoder[B]

def xmapc[B](f: (A) ⇒ B)(g: (B) ⇒ A): Decoder[B]

def →[B](y: B): (Decoder[A], B)

Shadowed Implicit Value Members

val self: Decoder[A]

val self: Decoder[A]

Deprecated Value Members

def pxmap[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): Decoder[B]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion EnrichedCoproductDecoder from Decoder[A] to EnrichedCoproductDecoder[A]

Inherited by implicit conversion TransformSyntax from Decoder[A] to TransformSyntax[Decoder, A]

Inherited by implicit conversion any2stringadd from Decoder[A] to any2stringadd[Decoder[A]]

Inherited by implicit conversion StringFormat from Decoder[A] to StringFormat[Decoder[A]]

Inherited by implicit conversion Ensuring from Decoder[A] to Ensuring[Decoder[A]]

Inherited by implicit conversion ArrowAssoc from Decoder[A] to ArrowAssoc[Decoder[A]]

Primary Members

Basic Combinators

Coproduct Support

Ungrouped