scodec.codecs

KnownDiscriminatorType

trait KnownDiscriminatorType[D] extends AnyRef

Mixin for codecs/decoders that are known to discriminate by values of type D.

Source
KnownDiscriminatorType.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. KnownDiscriminatorType
  2. AnyRef
  3. Any
Implicitly
  1. by ValueEnrichedWithTuplingSupport
  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

Type Members

  1. case class UnknownDiscriminator(discriminator: D, context: List[String]) extends Err with Product with Serializable

    Error raised when an unknown discriminator is encountered when decoding.

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

    Implicit information
    This member is added by an implicit conversion from KnownDiscriminatorType[D] to ArrowAssoc[KnownDiscriminatorType[D]] 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. val a: KnownDiscriminatorType[D]

    Implicit information
    This member is added by an implicit conversion from KnownDiscriminatorType[D] to ValueEnrichedWithTuplingSupport[KnownDiscriminatorType[D]] performed by method ValueEnrichedWithTuplingSupport in scodec.codecs.
    Definition Classes
    ValueEnrichedWithTuplingSupport
  9. def as[B](implicit as: Transformer[D, B]): KnownDiscriminatorType[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 KnownDiscriminatorType[D] to TransformSyntax[KnownDiscriminatorType, D] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[KnownDiscriminatorType] is in scope.
    Definition Classes
    TransformSyntax
  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def clone(): AnyRef

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

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

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

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

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

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

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

    Curried version of exmap.

    Curried version of exmap.

    Implicit information
    This member is added by an implicit conversion from KnownDiscriminatorType[D] to TransformSyntax[KnownDiscriminatorType, D] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[KnownDiscriminatorType] 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 formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from KnownDiscriminatorType[D] 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. def narrow[B](f: (D) ⇒ Attempt[B], g: (B) ⇒ D): KnownDiscriminatorType[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 KnownDiscriminatorType[D] to TransformSyntax[KnownDiscriminatorType, D] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[KnownDiscriminatorType] is in scope.
    Definition Classes
    TransformSyntax
  26. def narrowc[B](f: (D) ⇒ Attempt[B])(g: (B) ⇒ D): KnownDiscriminatorType[B]

    Curried version of narrow.

    Curried version of narrow.

    Implicit information
    This member is added by an implicit conversion from KnownDiscriminatorType[D] to TransformSyntax[KnownDiscriminatorType, D] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[KnownDiscriminatorType] is in scope.
    Definition Classes
    TransformSyntax
  27. final def ne(arg0: AnyRef): Boolean

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

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

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

    Definition Classes
    AnyRef
  31. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def widen[B](f: (D) ⇒ B, g: (B) ⇒ Attempt[D]): KnownDiscriminatorType[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 KnownDiscriminatorType[D] to TransformSyntax[KnownDiscriminatorType, D] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[KnownDiscriminatorType] is in scope.
    Definition Classes
    TransformSyntax
  36. def widenOpt[B](f: (D) ⇒ B, g: (B) ⇒ Option[D]): KnownDiscriminatorType[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 KnownDiscriminatorType[D] to TransformSyntax[KnownDiscriminatorType, D] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[KnownDiscriminatorType] is in scope.
    Definition Classes
    TransformSyntax
  37. def widenOptc[B](f: (D) ⇒ B)(g: (B) ⇒ Option[D]): KnownDiscriminatorType[B]

    Curried version of widenOpt.

    Curried version of widenOpt.

    Implicit information
    This member is added by an implicit conversion from KnownDiscriminatorType[D] to TransformSyntax[KnownDiscriminatorType, D] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[KnownDiscriminatorType] is in scope.
    Definition Classes
    TransformSyntax
  38. def widenc[B](f: (D) ⇒ B)(g: (B) ⇒ Attempt[D]): KnownDiscriminatorType[B]

    Curried version of widen.

    Curried version of widen.

    Implicit information
    This member is added by an implicit conversion from KnownDiscriminatorType[D] to TransformSyntax[KnownDiscriminatorType, D] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[KnownDiscriminatorType] is in scope.
    Definition Classes
    TransformSyntax
  39. def xmap[B](f: (D) ⇒ B, g: (B) ⇒ D): KnownDiscriminatorType[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 KnownDiscriminatorType[D] to TransformSyntax[KnownDiscriminatorType, D] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[KnownDiscriminatorType] is in scope.
    Definition Classes
    TransformSyntax
  40. def xmapc[B](f: (D) ⇒ B)(g: (B) ⇒ D): KnownDiscriminatorType[B]

    Curried version of xmap.

    Curried version of xmap.

    Implicit information
    This member is added by an implicit conversion from KnownDiscriminatorType[D] to TransformSyntax[KnownDiscriminatorType, D] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[KnownDiscriminatorType] is in scope.
    Definition Classes
    TransformSyntax
  41. def ~[B](b: B): (KnownDiscriminatorType[D], B)

    Implicit information
    This member is added by an implicit conversion from KnownDiscriminatorType[D] to ValueEnrichedWithTuplingSupport[KnownDiscriminatorType[D]] performed by method ValueEnrichedWithTuplingSupport in scodec.codecs.
    Definition Classes
    ValueEnrichedWithTuplingSupport
  42. def [B](y: B): (KnownDiscriminatorType[D], B)

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

Shadowed Implicit Value Members

  1. val self: KnownDiscriminatorType[D]

    Supports TransformSyntax.

    Supports TransformSyntax.

    Implicit information
    This member is added by an implicit conversion from KnownDiscriminatorType[D] to TransformSyntax[KnownDiscriminatorType, D] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[KnownDiscriminatorType] 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:
    (knownDiscriminatorType: TransformSyntax[KnownDiscriminatorType, D]).self
    Definition Classes
    TransformSyntax
  2. val self: Any

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

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

Deprecated Value Members

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

    (Since version 1.7.0) Use widenOpt instead

  2. def x: KnownDiscriminatorType[D]

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

    (Since version 2.10.0) Use leftOfArrow instead

  3. def x: KnownDiscriminatorType[D]

    Implicit information
    This member is added by an implicit conversion from KnownDiscriminatorType[D] to Ensuring[KnownDiscriminatorType[D]] 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:
    (knownDiscriminatorType: Ensuring[KnownDiscriminatorType[D]]).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 ValueEnrichedWithTuplingSupport from KnownDiscriminatorType[D] to ValueEnrichedWithTuplingSupport[KnownDiscriminatorType[D]]

Inherited by implicit conversion TransformSyntax from KnownDiscriminatorType[D] to TransformSyntax[KnownDiscriminatorType, D]

Inherited by implicit conversion any2stringadd from KnownDiscriminatorType[D] to StringAdd

Inherited by implicit conversion any2stringfmt from KnownDiscriminatorType[D] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from KnownDiscriminatorType[D] to ArrowAssoc[KnownDiscriminatorType[D]]

Inherited by implicit conversion any2Ensuring from KnownDiscriminatorType[D] to Ensuring[KnownDiscriminatorType[D]]

Combinators

Ungrouped