scodec

Decoder

trait Decoder[+A] extends AnyRef

Supports decoding a value of type A from a BitVector.

Self Type
Decoder[A]
Source
Decoder.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Codec, DiscriminatorCodec, GenCodec, PaddedVarAlignedCodec, Tuple10Codec, Tuple11Codec, Tuple12Codec, Tuple3Codec, Tuple4Codec, Tuple5Codec, Tuple6Codec, Tuple7Codec, Tuple8Codec, Tuple9Codec, TupleCodec
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. Decoder
  2. AnyRef
  3. Any
Implicitly
  1. by EnrichedCoproductDecoder
  2. by TransformSyntax
  3. by any2stringadd
  4. by any2stringfmt
  5. by any2ArrowAssoc
  6. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. 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

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

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

  5. 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 any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  8. 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

  9. def asDecoder: Decoder[A]

    Gets this as a Decoder.

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  12. def complete: Decoder[A]

    Converts this decoder to a new decoder that fails decoding if there are remaining bits.

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

    Converts this to a codec that fails encoding with an error.

  14. 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

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

    Converts this decoder to a Decoder[B] using the supplied A => Attempt[B].

  16. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  17. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  18. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  19. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Definition Classes
    AnyRef

  21. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  22. 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

  23. 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

  24. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Converts this decoder to a Decoder[B] using the supplied A => Decoder[B].

  26. def formatted(fmtstr: String): String

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

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

    Definition Classes
    AnyRef → Any

  28. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  29. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Converts this decoder to a Decoder[B] using the supplied A => B.

  31. 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

  32. 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

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

    Definition Classes
    AnyRef

  34. final def notify(): Unit

    Definition Classes
    AnyRef

  35. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  36. 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

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

    Definition Classes
    AnyRef

  38. def toString(): String

    Definition Classes
    AnyRef → Any

  39. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  41. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  42. 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

  43. 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

  44. 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

  45. 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

  46. 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

  47. 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

  48. 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 any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. 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

  2. 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

  3. val self: Any

    Implicit information
    This member is added by an implicit conversion from Decoder[A] to StringAdd performed by method any2stringadd in scala.Predef.
    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: StringAdd).self
    Definition Classes
    StringAdd

  4. val self: Any

    Implicit information
    This member is added by an implicit conversion from Decoder[A] to StringFormat performed by method any2stringfmt in scala.Predef.
    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: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. 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

  2. def x: Decoder[A]

    Implicit information
    This member is added by an implicit conversion from Decoder[A] to ArrowAssoc[Decoder[A]] performed by method any2ArrowAssoc in scala.Predef.
    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: ArrowAssoc[Decoder[A]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  3. def x: Decoder[A]

    Implicit information
    This member is added by an implicit conversion from Decoder[A] to Ensuring[Decoder[A]] performed by method any2Ensuring in scala.Predef.
    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: Ensuring[Decoder[A]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring 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 StringAdd

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

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

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

Primary Members

Basic Combinators

Coproduct Support

Ungrouped