Class/Object

scodec.codecs

CoproductBuilderAuto

Related Docs: object CoproductBuilderAuto | package codecs

Permalink

sealed abstract class CoproductBuilderAuto[A] extends DepFn0

Witness that a coproduct codec builder of type A can be automatically created.

Source
CoproductCodec.scala
Linear Supertypes
DepFn0, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. CoproductBuilderAuto
  2. DepFn0
  3. AnyRef
  4. 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

Type Members

  1. abstract type C <: Coproduct

    Permalink

  2. abstract type L <: HList

    Permalink

  3. type Out = CoproductCodecBuilder[C, L, A]

    Permalink
    Definition Classes
    CoproductBuilderAuto → DepFn0

Abstract Value Members

  1. abstract def apply(): Out

    Permalink
    Definition Classes
    CoproductBuilderAuto → DepFn0

Concrete 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 CoproductBuilderAuto[A] to any2stringadd[CoproductBuilderAuto[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (CoproductBuilderAuto[A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from CoproductBuilderAuto[A] to ArrowAssoc[CoproductBuilderAuto[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: CoproductBuilderAuto[A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from CoproductBuilderAuto[A] to ValueEnrichedWithTuplingSupport[CoproductBuilderAuto[A]] performed by method ValueEnrichedWithTuplingSupport in scodec.codecs.
    Definition Classes
    ValueEnrichedWithTuplingSupport

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

  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  9. def clone(): AnyRef

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

  10. def ensuring(cond: (CoproductBuilderAuto[A]) ⇒ Boolean, msg: ⇒ Any): CoproductBuilderAuto[A]

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

  11. def ensuring(cond: (CoproductBuilderAuto[A]) ⇒ Boolean): CoproductBuilderAuto[A]

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

  12. def ensuring(cond: Boolean, msg: ⇒ Any): CoproductBuilderAuto[A]

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

  13. def ensuring(cond: Boolean): CoproductBuilderAuto[A]

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

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

    Permalink
    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

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

  17. def exmapc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ Attempt[A]): CoproductBuilderAuto[B]

    Permalink

    Curried version of exmap.

    Curried version of exmap.

    Implicit information
    This member is added by an implicit conversion from CoproductBuilderAuto[A] to TransformSyntax[CoproductBuilderAuto, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[CoproductBuilderAuto] is in scope.
    Definition Classes
    TransformSyntax

  18. def finalize(): Unit

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

  19. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from CoproductBuilderAuto[A] to StringFormat[CoproductBuilderAuto[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Permalink
    Definition Classes
    AnyRef → Any

  21. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

  24. def narrowc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ A): CoproductBuilderAuto[B]

    Permalink

    Curried version of narrow.

    Curried version of narrow.

    Implicit information
    This member is added by an implicit conversion from CoproductBuilderAuto[A] to TransformSyntax[CoproductBuilderAuto, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[CoproductBuilderAuto] is in scope.
    Definition Classes
    TransformSyntax

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

    Permalink
    Definition Classes
    AnyRef

  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  28. val self: CoproductBuilderAuto[A]

    Permalink

    Supports TransformSyntax.

    Supports TransformSyntax.

    Implicit information
    This member is added by an implicit conversion from CoproductBuilderAuto[A] to TransformSyntax[CoproductBuilderAuto, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[CoproductBuilderAuto] is in scope.
    Definition Classes
    TransformSyntax

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

    Permalink
    Definition Classes
    AnyRef

  30. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  31. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

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

  36. def widenOptc[B](f: (A) ⇒ B)(g: (B) ⇒ Option[A]): CoproductBuilderAuto[B]

    Permalink

    Curried version of widenOpt.

    Curried version of widenOpt.

    Implicit information
    This member is added by an implicit conversion from CoproductBuilderAuto[A] to TransformSyntax[CoproductBuilderAuto, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[CoproductBuilderAuto] is in scope.
    Definition Classes
    TransformSyntax

  37. def widenc[B](f: (A) ⇒ B)(g: (B) ⇒ Attempt[A]): CoproductBuilderAuto[B]

    Permalink

    Curried version of widen.

    Curried version of widen.

    Implicit information
    This member is added by an implicit conversion from CoproductBuilderAuto[A] to TransformSyntax[CoproductBuilderAuto, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[CoproductBuilderAuto] is in scope.
    Definition Classes
    TransformSyntax

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

  39. def xmapc[B](f: (A) ⇒ B)(g: (B) ⇒ A): CoproductBuilderAuto[B]

    Permalink

    Curried version of xmap.

    Curried version of xmap.

    Implicit information
    This member is added by an implicit conversion from CoproductBuilderAuto[A] to TransformSyntax[CoproductBuilderAuto, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[CoproductBuilderAuto] is in scope.
    Definition Classes
    TransformSyntax

  40. def ~[B](b: B): (CoproductBuilderAuto[A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from CoproductBuilderAuto[A] to ValueEnrichedWithTuplingSupport[CoproductBuilderAuto[A]] performed by method ValueEnrichedWithTuplingSupport in scodec.codecs.
    Definition Classes
    ValueEnrichedWithTuplingSupport

  41. def →[B](y: B): (CoproductBuilderAuto[A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from CoproductBuilderAuto[A] to ArrowAssoc[CoproductBuilderAuto[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]): CoproductBuilderAuto[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 CoproductBuilderAuto[A] to TransformSyntax[CoproductBuilderAuto, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[CoproductBuilderAuto] is in scope.
    Definition Classes
    TransformSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 1.7.0) Use widenOpt instead

Inherited from DepFn0

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion ValueEnrichedWithTuplingSupport from CoproductBuilderAuto[A] to ValueEnrichedWithTuplingSupport[CoproductBuilderAuto[A]]

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

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

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

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

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

Combinators

Ungrouped