Class/Object

scodec

DecodingContext

Related Docs: object DecodingContext | package scodec

Permalink

sealed abstract class DecodingContext[A] extends AnyRef

Provides the ability to sequence decoding operations such that the remainder of an operation is fed in to the input of the next operation. This is useful when using codecs in for comprehensions for decoding purposes.

Note: this is a domain specific fail fast state monad.

Self Type
DecodingContext[A]
Source
DecodingContext.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. DecodingContext
  2. AnyRef
  3. Any
Implicitly
  1. by TransformSyntax
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def decode(buffer: BitVector): Attempt[DecodeResult[A]]

    Permalink

    Runs the sequenced decoding operations by decoding the specified bit vector.

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  6. def as[B](implicit as: Transformer[A, B]): DecodingContext[B]

    Permalink

    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 DecodingContext[A] to TransformSyntax[DecodingContext, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[DecodingContext] is in scope.
    Definition Classes
    TransformSyntax

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  8. def clone(): AnyRef

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. def exmap[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ Attempt[A]): DecodingContext[B]

    Permalink

    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 DecodingContext[A] to TransformSyntax[DecodingContext, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[DecodingContext] is in scope.
    Definition Classes
    TransformSyntax

  16. def exmapc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ Attempt[A]): DecodingContext[B]

    Permalink

    Curried version of exmap.

    Curried version of exmap.

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

  17. def finalize(): Unit

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

  18. def flatMap[B](f: (A) ⇒ DecodingContext[B]): DecodingContext[B]

    Permalink

    Returns a context that first decodes using this context, then uses the decoded value and the supplied function to generate a subsequent context, and decodes the remainder of the first decoding operation with the subsequent context.

  19. def formatted(fmtstr: String): String

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  21. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  23. final def map[B](f: (A) ⇒ B): DecodingContext[B]

    Permalink

    Transforms the decoded value using the supplied function.

  24. final def mapErr(f: (Err) ⇒ Err): DecodingContext[A]

    Permalink

    Transforms the decoding error using the supplied function.

  25. def narrow[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ A): DecodingContext[B]

    Permalink

    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 DecodingContext[A] to TransformSyntax[DecodingContext, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[DecodingContext] is in scope.
    Definition Classes
    TransformSyntax

  26. def narrowc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ A): DecodingContext[B]

    Permalink

    Curried version of narrow.

    Curried version of narrow.

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

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

    Permalink
    Definition Classes
    AnyRef

  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  30. val self: DecodingContext[A]

    Permalink

    Supports TransformSyntax.

    Supports TransformSyntax.

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

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

    Permalink
    Definition Classes
    AnyRef

  32. def toDecoder: Decoder[A]

    Permalink

    Converts this context to a decoder instance.

  33. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  34. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  37. def widen[B](f: (A) ⇒ B, g: (B) ⇒ Attempt[A]): DecodingContext[B]

    Permalink

    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 DecodingContext[A] to TransformSyntax[DecodingContext, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[DecodingContext] is in scope.
    Definition Classes
    TransformSyntax

  38. def widenOpt[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): DecodingContext[B]

    Permalink

    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 DecodingContext[A] to TransformSyntax[DecodingContext, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[DecodingContext] is in scope.
    Definition Classes
    TransformSyntax

  39. def widenOptc[B](f: (A) ⇒ B)(g: (B) ⇒ Option[A]): DecodingContext[B]

    Permalink

    Curried version of widenOpt.

    Curried version of widenOpt.

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

  40. def widenc[B](f: (A) ⇒ B)(g: (B) ⇒ Attempt[A]): DecodingContext[B]

    Permalink

    Curried version of widen.

    Curried version of widen.

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

  41. def xmap[B](f: (A) ⇒ B, g: (B) ⇒ A): DecodingContext[B]

    Permalink

    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 DecodingContext[A] to TransformSyntax[DecodingContext, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[DecodingContext] is in scope.
    Definition Classes
    TransformSyntax

  42. def xmapc[B](f: (A) ⇒ B)(g: (B) ⇒ A): DecodingContext[B]

    Permalink

    Curried version of xmap.

    Curried version of xmap.

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

  43. def →[B](y: B): (DecodingContext[A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from DecodingContext[A] to ArrowAssoc[DecodingContext[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]): DecodingContext[B]

    Permalink

    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 DecodingContext[A] to TransformSyntax[DecodingContext, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[DecodingContext] 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 TransformSyntax from DecodingContext[A] to TransformSyntax[DecodingContext, A]

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

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

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

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

combinators

Ungrouped