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, 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 StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  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: Any): Boolean

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

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

  4. 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()

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

    Definition Classes
    AnyRef → Any

  6. 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. This conversion will take place only if an implicit value of type Transform[Decoder] is in scope.
    Definition Classes
    TransformSyntax

  7. def asDecoder: Decoder[A]

    Gets this as a Decoder.

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

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

  10. def complete: Decoder[A]

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    AnyRef

  18. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  19. 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. This conversion will take place only if an implicit value of type Transform[Decoder] is in scope.
    Definition Classes
    TransformSyntax

  20. def finalize(): Unit

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

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

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

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

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

    Definition Classes
    AnyRef → Any

  24. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

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

  27. 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. This conversion will take place only if an implicit value of type Transform[Decoder] is in scope.
    Definition Classes
    TransformSyntax

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

    Definition Classes
    AnyRef

  29. final def notify(): Unit

    Definition Classes
    AnyRef

  30. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

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

    Definition Classes
    AnyRef

  33. def toString(): String

    Definition Classes
    AnyRef → Any

  34. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  37. 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. This conversion will take place only if an implicit value of type Transform[Decoder] is in scope.
    Definition Classes
    TransformSyntax

  38. 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. This conversion will take place only if an implicit value of type Transform[Decoder] is in scope.
    Definition Classes
    TransformSyntax

  39. 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. This conversion will take place only if an implicit value of type Transform[Decoder] is in scope.
    Definition Classes
    TransformSyntax

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

  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. This conversion will take place only if an implicit value of type Transform[Decoder] is in scope.
    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

  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. This conversion will take place only if an implicit value of type Transform[Decoder] is in scope.
    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