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
AnyRef, Any
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 StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  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: 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 KnownDiscriminatorType[D] to any2stringadd[KnownDiscriminatorType[D]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. 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 ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  6. 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
  7. 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
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. 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 Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. 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 Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. 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 Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. 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 Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  16. 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
  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def formatted(fmtstr: String): String

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

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

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

    Definition Classes
    Any
  22. 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
  23. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  26. 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.
    Definition Classes
    TransformSyntax
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  28. def toString(): String

    Definition Classes
    AnyRef → Any
  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: (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
  33. 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
  34. 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
  35. 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
  36. 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 ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

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

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 any2stringadd[KnownDiscriminatorType[D]]

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

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

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

Combinators

Ungrouped