Class

scodec.codecs.CoproductCodecBuilder

NeedDiscriminators

Related Doc: package CoproductCodecBuilder

Permalink

final class NeedDiscriminators[A] extends AnyRef

Assists in creating a coproduct codec, after the coproduct type and discriminator type have been fixed.

Source
CoproductCodec.scala
Linear Supertypes
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. NeedDiscriminators
  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
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from NeedDiscriminators[A] to any2stringadd[NeedDiscriminators[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (NeedDiscriminators[A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from NeedDiscriminators[A] to ArrowAssoc[NeedDiscriminators[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. val a: NeedDiscriminators[A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from NeedDiscriminators[A] to ValueEnrichedWithTuplingSupport[NeedDiscriminators[A]] performed by method ValueEnrichedWithTuplingSupport in scodec.codecs.
    Definition Classes
    ValueEnrichedWithTuplingSupport
  7. def as[B](implicit as: Transformer[A, B]): NeedDiscriminators[B]

    Permalink

    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 NeedDiscriminators[A] to TransformSyntax[NeedDiscriminators, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[NeedDiscriminators] is in scope.
    Definition Classes
    TransformSyntax
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def auto(implicit auto: CoproductBuilderAutoDiscriminators[R, C, A]): Codec[R] with KnownDiscriminatorType[A]

    Permalink

    Determines discriminators values automatically by looking for a Discriminator[R, X, A] for each component type X in the coproduct C.

  10. def clone(): AnyRef

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. def exmap[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ Attempt[A]): NeedDiscriminators[B]

    Permalink

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

    Permalink

    Curried version of exmap.

    Curried version of exmap.

    Implicit information
    This member is added by an implicit conversion from NeedDiscriminators[A] to TransformSyntax[NeedDiscriminators, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[NeedDiscriminators] is in scope.
    Definition Classes
    TransformSyntax
  19. def finalize(): Unit

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

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

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

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

    Permalink
    Definition Classes
    Any
  24. def narrow[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ A): NeedDiscriminators[B]

    Permalink

    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 NeedDiscriminators[A] to TransformSyntax[NeedDiscriminators, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[NeedDiscriminators] is in scope.
    Definition Classes
    TransformSyntax
  25. def narrowc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ A): NeedDiscriminators[B]

    Permalink

    Curried version of narrow.

    Curried version of narrow.

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

    Permalink
    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. val self: NeedDiscriminators[A]

    Permalink

    Supports TransformSyntax.

    Supports TransformSyntax.

    Implicit information
    This member is added by an implicit conversion from NeedDiscriminators[A] to TransformSyntax[NeedDiscriminators, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[NeedDiscriminators] is in scope.
    Definition Classes
    TransformSyntax
  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  31. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  32. def using[Rec <: HList](bindings: Rec)(implicit keyDiscriminators: CoproductBuilderKeyDiscriminators[C, Rec, A]): Codec[R] with KnownDiscriminatorType[A]

    Permalink

    Specifies the discriminator values for each of the union type members by providing the discriminators as a record with the same keys as the union.

  33. def using[N <: Nat](discriminators: Sized[Seq[A], N])(implicit ev: Aux[C, N]): Codec[R] with KnownDiscriminatorType[A]

    Permalink

    Specifies the discriminator values for each of the coproduct type members.

    Specifies the discriminator values for each of the coproduct type members.

    The collection must list the discriminators in the order that the corresponding types appear in the coproduct.

  34. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. def widen[B](f: (A) ⇒ B, g: (B) ⇒ Attempt[A]): NeedDiscriminators[B]

    Permalink

    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 NeedDiscriminators[A] to TransformSyntax[NeedDiscriminators, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[NeedDiscriminators] is in scope.
    Definition Classes
    TransformSyntax
  38. def widenOpt[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): NeedDiscriminators[B]

    Permalink

    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 NeedDiscriminators[A] to TransformSyntax[NeedDiscriminators, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[NeedDiscriminators] is in scope.
    Definition Classes
    TransformSyntax
  39. def widenOptc[B](f: (A) ⇒ B)(g: (B) ⇒ Option[A]): NeedDiscriminators[B]

    Permalink

    Curried version of widenOpt.

    Curried version of widenOpt.

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

    Permalink

    Curried version of widen.

    Curried version of widen.

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

    Permalink

    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 NeedDiscriminators[A] to TransformSyntax[NeedDiscriminators, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[NeedDiscriminators] is in scope.
    Definition Classes
    TransformSyntax
  42. def xmapc[B](f: (A) ⇒ B)(g: (B) ⇒ A): NeedDiscriminators[B]

    Permalink

    Curried version of xmap.

    Curried version of xmap.

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

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

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

Deprecated Value Members

  1. def pxmap[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): NeedDiscriminators[B]

    Permalink

    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 NeedDiscriminators[A] to TransformSyntax[NeedDiscriminators, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[NeedDiscriminators] 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 NeedDiscriminators[A] to ValueEnrichedWithTuplingSupport[NeedDiscriminators[A]]

Inherited by implicit conversion TransformSyntax from NeedDiscriminators[A] to TransformSyntax[NeedDiscriminators, A]

Inherited by implicit conversion any2stringadd from NeedDiscriminators[A] to any2stringadd[NeedDiscriminators[A]]

Inherited by implicit conversion StringFormat from NeedDiscriminators[A] to StringFormat[NeedDiscriminators[A]]

Inherited by implicit conversion Ensuring from NeedDiscriminators[A] to Ensuring[NeedDiscriminators[A]]

Inherited by implicit conversion ArrowAssoc from NeedDiscriminators[A] to ArrowAssoc[NeedDiscriminators[A]]

Combinators

Ungrouped