scodec

DecodeResult

Related Doc: package scodec

final case class DecodeResult[+A](value: A, remainder: BitVector) extends Product with Serializable

Result of a decoding operation, which consists of the decoded value and the remaining bits that were not consumed by decoding.

Source
DecodeResult.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. DecodeResult
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by TransformSyntax
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DecodeResult(value: A, remainder: BitVector)

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 DecodeResult[A] to any2stringadd[DecodeResult[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (DecodeResult[A], B)

    Implicit information
    This member is added by an implicit conversion from DecodeResult[A] to ArrowAssoc[DecodeResult[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]): DecodeResult[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 DecodeResult[A] to TransformSyntax[DecodeResult, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[DecodeResult] is in scope.
    Definition Classes
    TransformSyntax

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def clone(): AnyRef

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

  9. def ensuring(cond: (DecodeResult[A]) ⇒ Boolean, msg: ⇒ Any): DecodeResult[A]

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

  10. def ensuring(cond: (DecodeResult[A]) ⇒ Boolean): DecodeResult[A]

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

  11. def ensuring(cond: Boolean, msg: ⇒ Any): DecodeResult[A]

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

  12. def ensuring(cond: Boolean): DecodeResult[A]

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

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

    Definition Classes
    AnyRef

  14. def exmap[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ Attempt[A]): DecodeResult[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 DecodeResult[A] to TransformSyntax[DecodeResult, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[DecodeResult] is in scope.
    Definition Classes
    TransformSyntax

  15. def finalize(): Unit

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

  16. def formatted(fmtstr: String): String

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

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

    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  19. def map[B](f: (A) ⇒ B): DecodeResult[B]

    Maps the supplied function over the decoded value.

  20. def mapRemainder(f: (BitVector) ⇒ BitVector): DecodeResult[A]

    Maps the supplied function over the remainder.

  21. def narrow[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ A): DecodeResult[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 DecodeResult[A] to TransformSyntax[DecodeResult, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[DecodeResult] is in scope.
    Definition Classes
    TransformSyntax

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

    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  25. val remainder: BitVector

  26. val self: DecodeResult[A]

    Supports TransformSyntax.

    Supports TransformSyntax.

    Implicit information
    This member is added by an implicit conversion from DecodeResult[A] to TransformSyntax[DecodeResult, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[DecodeResult] is in scope.
    Definition Classes
    TransformSyntax

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

    Definition Classes
    AnyRef

  28. val value: A

  29. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. def widen[B](f: (A) ⇒ B, g: (B) ⇒ Attempt[A]): DecodeResult[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 DecodeResult[A] to TransformSyntax[DecodeResult, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[DecodeResult] is in scope.
    Definition Classes
    TransformSyntax

  33. def widenOpt[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): DecodeResult[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 DecodeResult[A] to TransformSyntax[DecodeResult, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[DecodeResult] is in scope.
    Definition Classes
    TransformSyntax

  34. def xmap[B](f: (A) ⇒ B, g: (B) ⇒ A): DecodeResult[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 DecodeResult[A] to TransformSyntax[DecodeResult, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[DecodeResult] is in scope.
    Definition Classes
    TransformSyntax

  35. def →[B](y: B): (DecodeResult[A], B)

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

Deprecated Value Members

  1. def pxmap[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): DecodeResult[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 DecodeResult[A] to TransformSyntax[DecodeResult, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[DecodeResult] is in scope.
    Definition Classes
    TransformSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 1.7.0) Use widenOpt instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

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

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

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

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

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

Basic Combinators

Members