Class

scodec

TransformSyntax

Related Doc: package scodec

Permalink

implicit class TransformSyntax[F[_], A] extends AnyRef

Provides method syntax for working with a type constructor that has a Transform typeclass instance.

Source
package.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. TransformSyntax
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TransformSyntax(self: F[A])(implicit t: Transform[F])

    Permalink

    self

    Supports TransformSyntax.

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from TransformSyntax[F, A] to ArrowAssoc[TransformSyntax[F, 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. def as[B](implicit as: Transformer[A, B]): F[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.

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  8. def clone(): AnyRef

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

  9. def ensuring(cond: (TransformSyntax[F, A]) ⇒ Boolean, msg: ⇒ Any): TransformSyntax[F, A]

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

  10. def ensuring(cond: (TransformSyntax[F, A]) ⇒ Boolean): TransformSyntax[F, A]

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

  11. def ensuring(cond: Boolean, msg: ⇒ Any): TransformSyntax[F, A]

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

  12. def ensuring(cond: Boolean): TransformSyntax[F, A]

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

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

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. def exmap[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ Attempt[A]): F[B]

    Permalink

    Transforms using two functions, A => Attempt[B] and B => Attempt[A].

  16. def exmapc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ Attempt[A]): F[B]

    Permalink

    Curried version of exmap.

  17. def finalize(): Unit

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

  18. def formatted(fmtstr: String): String

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  22. def narrow[B](f: (A) ⇒ Attempt[B], g: (B) ⇒ A): F[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.

  23. def narrowc[B](f: (A) ⇒ Attempt[B])(g: (B) ⇒ A): F[B]

    Permalink

    Curried version of narrow.

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

    Permalink
    Definition Classes
    AnyRef

  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  27. val self: F[A]

    Permalink

    Supports TransformSyntax.

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

    Permalink
    Definition Classes
    AnyRef

  29. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  30. final def wait(): Unit

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

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

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

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

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

  33. def widen[B](f: (A) ⇒ B, g: (B) ⇒ Attempt[A]): F[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.

  34. def widenOpt[B](f: (A) ⇒ B, g: (B) ⇒ Option[A]): F[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).

  35. def widenOptc[B](f: (A) ⇒ B)(g: (B) ⇒ Option[A]): F[B]

    Permalink

    Curried version of widenOpt.

  36. def widenc[B](f: (A) ⇒ B)(g: (B) ⇒ Attempt[A]): F[B]

    Permalink

    Curried version of widen.

  37. def xmap[B](f: (A) ⇒ B, g: (B) ⇒ A): F[B]

    Permalink

    Transforms using the isomorphism described by two functions, A => B and B => A.

  38. def xmapc[B](f: (A) ⇒ B)(g: (B) ⇒ A): F[B]

    Permalink

    Curried version of xmap.

  39. def →[B](y: B): (TransformSyntax[F, A], B)

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

    Annotations
    @deprecated
    Deprecated

    (Since version 1.7.0) Use widenOpt instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from TransformSyntax[F, A] to any2stringadd[TransformSyntax[F, A]]

Inherited by implicit conversion StringFormat from TransformSyntax[F, A] to StringFormat[TransformSyntax[F, A]]

Inherited by implicit conversion Ensuring from TransformSyntax[F, A] to Ensuring[TransformSyntax[F, A]]

Inherited by implicit conversion ArrowAssoc from TransformSyntax[F, A] to ArrowAssoc[TransformSyntax[F, A]]

combinators

Ungrouped