scodec

ValueCodecEnrichedWithGenericSupport

Related Doc: package scodec

implicit final class ValueCodecEnrichedWithGenericSupport[A] extends AnyVal

Provides syntax related to generic programming for codecs of any type.

Source
package.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. ValueCodecEnrichedWithGenericSupport
  2. AnyVal
  3. Any
Implicitly
  1. by TransformSyntax
  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 ValueCodecEnrichedWithGenericSupport(self: Codec[A])

Value Members

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

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

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

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

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

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

    Definition Classes
    Any
  8. def ensuring(cond: (ValueCodecEnrichedWithGenericSupport[A]) ⇒ Boolean, msg: ⇒ Any): ValueCodecEnrichedWithGenericSupport[A]

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

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

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

    Implicit information
    This member is added by an implicit conversion from ValueCodecEnrichedWithGenericSupport[A] to Ensuring[ValueCodecEnrichedWithGenericSupport[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def exmap[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ Attempt[A]): ValueCodecEnrichedWithGenericSupport[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 ValueCodecEnrichedWithGenericSupport[A] to TransformSyntax[ValueCodecEnrichedWithGenericSupport, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[ValueCodecEnrichedWithGenericSupport] is in scope.
    Definition Classes
    TransformSyntax
  13. def formatted(fmtstr: String): String

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

    Definition Classes
    AnyVal → Any
  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  16. def narrow[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ A): ValueCodecEnrichedWithGenericSupport[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 ValueCodecEnrichedWithGenericSupport[A] to TransformSyntax[ValueCodecEnrichedWithGenericSupport, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[ValueCodecEnrichedWithGenericSupport] is in scope.
    Definition Classes
    TransformSyntax
  17. def polyxmap[B](p: Poly, q: Poly)(implicit aToB: Aux[p.type, ::[A, HNil], B], bToA: Aux[q.type, ::[B, HNil], A]): Codec[B]

    Polymorphic function version of xmap.

    Polymorphic function version of xmap.

    When called on a Codec[A] where A is not a subytpe of HList, returns a new codec that's the result of xmapping with p and q, using p to convert from A to B and using q to convert from B to A.

    p

    polymorphic function that converts from A to B

    q

    polymorphic function that converts from B to A

  18. def polyxmap1[B](p: Poly)(implicit aToB: Aux[p.type, ::[A, HNil], B], bToA: Aux[p.type, ::[B, HNil], A]): Codec[B]

    Polymorphic function version of xmap that uses a single polymorphic function in both directions.

    Polymorphic function version of xmap that uses a single polymorphic function in both directions.

    When called on a Codec[A] where A is not a subytpe of HList, returns a new codec that's the result of xmapping with p for both forward and reverse directions.

    p

    polymorphic function that converts from A to B and from B to A

  19. val self: Codec[A]

  20. def toString(): String

    Definition Classes
    Any
  21. def widen[B](f: (A) ⇒ B, g: (B) ⇒ Attempt[A]): ValueCodecEnrichedWithGenericSupport[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 ValueCodecEnrichedWithGenericSupport[A] to TransformSyntax[ValueCodecEnrichedWithGenericSupport, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[ValueCodecEnrichedWithGenericSupport] is in scope.
    Definition Classes
    TransformSyntax
  22. def widenOpt[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): ValueCodecEnrichedWithGenericSupport[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 ValueCodecEnrichedWithGenericSupport[A] to TransformSyntax[ValueCodecEnrichedWithGenericSupport, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[ValueCodecEnrichedWithGenericSupport] is in scope.
    Definition Classes
    TransformSyntax
  23. def xmap[B](f: (A) ⇒ B, g: (B) ⇒ A): ValueCodecEnrichedWithGenericSupport[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 ValueCodecEnrichedWithGenericSupport[A] to TransformSyntax[ValueCodecEnrichedWithGenericSupport, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[ValueCodecEnrichedWithGenericSupport] is in scope.
    Definition Classes
    TransformSyntax
  24. def [B](y: B): (ValueCodecEnrichedWithGenericSupport[A], B)

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

Shadowed Implicit Value Members

  1. val self: ValueCodecEnrichedWithGenericSupport[A]

    Supports TransformSyntax.

    Supports TransformSyntax.

    Implicit information
    This member is added by an implicit conversion from ValueCodecEnrichedWithGenericSupport[A] to TransformSyntax[ValueCodecEnrichedWithGenericSupport, A] performed by method TransformSyntax in scodec. This conversion will take place only if an implicit value of type Transform[ValueCodecEnrichedWithGenericSupport] is in scope.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (valueCodecEnrichedWithGenericSupport: TransformSyntax[ValueCodecEnrichedWithGenericSupport, A]).self
    Definition Classes
    TransformSyntax

Deprecated Value Members

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

    (Since version 1.7.0) Use widenOpt instead

Inherited from AnyVal

Inherited from Any

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

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

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

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

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

combinators

generic

Ungrouped