scodec.codecs

Discriminator

final case class Discriminator[X, Y, D](value: D) extends Product with Serializable

Wrapper class that discriminates type Y in context of type X with a value of type D.

For example, consider a sealed trait and its subclasses. Each subclass could be assigned an integer by defining a Discriminator[Parent, Subclass, Int] for each.

X

context in which type Y is discriminated from other types

Y

type that is differentiated from other types by values of D

D

value type that discriminates values of Y from other types in context of X

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

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 Discriminator[X, Y, D] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (Discriminator[X, Y, D], B)

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

    Implicit information
    This member is added by an implicit conversion from Discriminator[X, Y, D] to ValueEnrichedWithTuplingSupport[Discriminator[X, Y, D]] performed by method ValueEnrichedWithTuplingSupport in scodec.codecs.
    Definition Classes
    ValueEnrichedWithTuplingSupport

  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: (Discriminator[X, Y, D]) ⇒ Boolean, msg: ⇒ Any): Discriminator[X, Y, D]

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

  12. def ensuring(cond: (Discriminator[X, Y, D]) ⇒ Boolean): Discriminator[X, Y, D]

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

  13. def ensuring(cond: Boolean, msg: ⇒ Any): Discriminator[X, Y, D]

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

  14. def ensuring(cond: Boolean): Discriminator[X, Y, D]

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

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

    Definition Classes
    AnyRef

  16. def finalize(): Unit

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

  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Discriminator[X, Y, D] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  24. val value: D

  25. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. def ~[B](b: B): (Discriminator[X, Y, D], B)

    Implicit information
    This member is added by an implicit conversion from Discriminator[X, Y, D] to ValueEnrichedWithTuplingSupport[Discriminator[X, Y, D]] performed by method ValueEnrichedWithTuplingSupport in scodec.codecs.
    Definition Classes
    ValueEnrichedWithTuplingSupport

  29. def →[B](y: B): (Discriminator[X, Y, D], B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Discriminator[X, Y, 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:
    (discriminator: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

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

Deprecated Value Members

  1. def x: Discriminator[X, Y, D]

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

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Discriminator[X, Y, D]

    Implicit information
    This member is added by an implicit conversion from Discriminator[X, Y, D] to Ensuring[Discriminator[X, Y, 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:
    (discriminator: Ensuring[Discriminator[X, Y, D]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

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

Inherited by implicit conversion any2stringadd from Discriminator[X, Y, D] to StringAdd

Inherited by implicit conversion any2stringfmt from Discriminator[X, Y, D] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Discriminator[X, Y, D] to ArrowAssoc[Discriminator[X, Y, D]]

Inherited by implicit conversion any2Ensuring from Discriminator[X, Y, D] to Ensuring[Discriminator[X, Y, D]]

Ungrouped