Class/Object

scodec

Transform

Related Docs: object Transform | package scodec

Permalink

abstract class Transform[F[_]] extends AnyRef

Typeclass that describes type constructors that support the exmap operation.

Self Type
Transform[F]
Source
Transform.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Transform
  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 Transform()

    Permalink

Abstract Value Members

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

    Permalink

    Transforms supplied F[A] to an F[B] using two functions, A => Attempt[B] and B => Attempt[A].

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

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

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

    Permalink

    Transforms supplied F[A] to an F[B] using implicitly available evidence that such a transformation is possible.

    Transforms supplied F[A] to an F[B] 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: (Transform[F]) ⇒ Boolean, msg: ⇒ Any): Transform[F]

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

  10. def ensuring(cond: (Transform[F]) ⇒ Boolean): Transform[F]

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

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

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

  12. def ensuring(cond: Boolean): Transform[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Transform[F] to Ensuring[Transform[F]] 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 finalize(): Unit

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

  16. def formatted(fmtstr: String): String

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  20. def narrow[A, B](fa: F[A], f: (A) ⇒ Attempt[B], g: (B) ⇒ A): F[B]

    Permalink

    Transforms supplied F[A] to an F[B] using two functions, A => Attempt[B] and B => A.

    Transforms supplied F[A] to an F[B] using two functions, A => Attempt[B] and B => A.

    The supplied functions form an injection from B to A. Hence, converting a F[A] to a F[B] converts from a larger to a smaller type. Hence, the name narrow.

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

    Permalink
    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  25. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  26. final def wait(): Unit

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

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

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

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

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

  29. def widen[A, B](fa: F[A], f: (A) ⇒ B, g: (B) ⇒ Attempt[A]): F[B]

    Permalink

    Transforms supplied F[A] to an F[B] using two functions, A => B and B => Attempt[A].

    Transforms supplied F[A] to an F[B] using two functions, A => B and B => Attempt[A].

    The supplied functions form an injection from A to B. Hence, converting a F[A] to a F[B] converts from a smaller to a larger type. Hence, the name widen.

  30. def widenOpt[A, B](fa: F[A], f: (A) ⇒ B, g: (B) ⇒ Option[A]): F[B]

    Permalink

    Transforms supplied F[A] to an F[B] using two functions, A => B and B => Option[A].

    Transforms supplied F[A] to an F[B] 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).

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

    Permalink

    Transforms supplied F[A] to an F[B] using the isomorphism described by two functions, A => B and B => A.

  32. def →[B](y: B): (Transform[F], B)

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

Deprecated Value Members

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

    Permalink

    Transforms supplied F[A] to an F[B] using two functions, A => B and B => Option[A].

    Transforms supplied F[A] to an F[B] 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 Transform[F] to any2stringadd[Transform[F]]

Inherited by implicit conversion StringFormat from Transform[F] to StringFormat[Transform[F]]

Inherited by implicit conversion Ensuring from Transform[F] to Ensuring[Transform[F]]

Inherited by implicit conversion ArrowAssoc from Transform[F] to ArrowAssoc[Transform[F]]

Ungrouped