scodec

DecodingContext

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]
Annotations
@deprecated
Deprecated

(Since version 1.8.2) Use flatMap on Codec or Decoder, which provides equivalent functionality

Source
DecodingContext.scala
Linear Supertypes
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. DecodingContext
  2. AnyRef
  3. Any
Implicitly
  1. by TransformSyntax
  2. by any2stringadd
  3. by any2stringfmt
  4. by any2ArrowAssoc
  5. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DecodingContext()

Abstract Value Members

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

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

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 DecodingContext[A] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (DecodingContext[A], B)

    Implicit information
    This member is added by an implicit conversion from DecodingContext[A] to ArrowAssoc[DecodingContext[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]): DecodingContext[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 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
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def ensuring(cond: (DecodingContext[A]) ⇒ Boolean, msg: ⇒ Any): DecodingContext[A]

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

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

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

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

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

    Definition Classes
    AnyRef → Any
  17. def exmap[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ Attempt[A]): DecodingContext[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 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
  18. def exmapc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ Attempt[A]): DecodingContext[B]

    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
  19. def finalize(): Unit

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

    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.

  21. def formatted(fmtstr: String): String

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

    Definition Classes
    AnyRef → Any
  23. def hashCode(): Int

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

    Definition Classes
    Any
  25. final def map[B](f: (A) ⇒ B): DecodingContext[B]

    Transforms the decoded value using the supplied function.

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

    Transforms the decoding error using the supplied function.

  27. def narrow[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ A): DecodingContext[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 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
  28. def narrowc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ A): DecodingContext[B]

    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
  29. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  30. final def notify(): Unit

    Definition Classes
    AnyRef
  31. final def notifyAll(): Unit

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

    Definition Classes
    AnyRef
  33. def toDecoder: Decoder[A]

    Converts this context to a decoder instance.

  34. def toString(): String

    Definition Classes
    AnyRef → Any
  35. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. def widen[B](f: (A) ⇒ B, g: (B) ⇒ Attempt[A]): DecodingContext[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 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 widenOpt[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): DecodingContext[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 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 widenOptc[B](f: (A) ⇒ B)(g: (B) ⇒ Option[A]): DecodingContext[B]

    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
  41. def widenc[B](f: (A) ⇒ B)(g: (B) ⇒ Attempt[A]): DecodingContext[B]

    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
  42. def xmap[B](f: (A) ⇒ B, g: (B) ⇒ A): DecodingContext[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 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 xmapc[B](f: (A) ⇒ B)(g: (B) ⇒ A): DecodingContext[B]

    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
  44. def [B](y: B): (DecodingContext[A], B)

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

Shadowed Implicit Value Members

  1. val self: DecodingContext[A]

    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.
    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:
    (decodingContext: TransformSyntax[DecodingContext, A]).self
    Definition Classes
    TransformSyntax
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from DecodingContext[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:
    (decodingContext: StringAdd).self
    Definition Classes
    StringAdd
  3. val self: Any

    Implicit information
    This member is added by an implicit conversion from DecodingContext[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:
    (decodingContext: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def pxmap[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): DecodingContext[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 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

  2. def x: DecodingContext[A]

    Implicit information
    This member is added by an implicit conversion from DecodingContext[A] to ArrowAssoc[DecodingContext[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:
    (decodingContext: ArrowAssoc[DecodingContext[A]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  3. def x: DecodingContext[A]

    Implicit information
    This member is added by an implicit conversion from DecodingContext[A] to Ensuring[DecodingContext[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:
    (decodingContext: Ensuring[DecodingContext[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 TransformSyntax from DecodingContext[A] to TransformSyntax[DecodingContext, A]

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

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

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

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

combinators

Ungrouped