scodec.codecs

Discriminated

final case class Discriminated[X, D](codec: Codec[D]) extends Product with Serializable

Wrapper class that indicates subtypes of X are discriminated by type D using the supplied Codec[D].

For example, an implicit Discriminated value can be defined in the companion of a sealed trait, along with implicit Discriminator values in each subtype companion. Given such implicits, a codec for the trait can be automatically derived using Codec[X].

X

type that can be discriminated by discriminator values of type D

D

value type that discriminates Y in context of X from other types using discriminators of D for some type Y

Source
Discriminator.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Discriminated
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by ValueEnrichedWithTuplingSupport
  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 Discriminated(codec: Codec[D])

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

    Implicit information
    This member is added by an implicit conversion from Discriminated[X, D] to ArrowAssoc[Discriminated[X, 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: Discriminated[X, D]

    Implicit information
    This member is added by an implicit conversion from Discriminated[X, D] to ValueEnrichedWithTuplingSupport[Discriminated[X, D]] performed by method ValueEnrichedWithTuplingSupport in scodec.codecs.
    Definition Classes
    ValueEnrichedWithTuplingSupport
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val codec: Codec[D]

  10. def ensuring(cond: (Discriminated[X, D]) ⇒ Boolean, msg: ⇒ Any): Discriminated[X, D]

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

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

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

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

    Definition Classes
    AnyRef
  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 Discriminated[X, D] to StringFormat[Discriminated[X, D]] 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. final def ne(arg0: AnyRef): Boolean

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

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

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

    Definition Classes
    AnyRef
  23. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def ~[B](b: B): (Discriminated[X, D], B)

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion ValueEnrichedWithTuplingSupport from Discriminated[X, D] to ValueEnrichedWithTuplingSupport[Discriminated[X, D]]

Inherited by implicit conversion any2stringadd from Discriminated[X, D] to any2stringadd[Discriminated[X, D]]

Inherited by implicit conversion StringFormat from Discriminated[X, D] to StringFormat[Discriminated[X, D]]

Inherited by implicit conversion Ensuring from Discriminated[X, D] to Ensuring[Discriminated[X, D]]

Inherited by implicit conversion ArrowAssoc from Discriminated[X, D] to ArrowAssoc[Discriminated[X, D]]

Ungrouped