scodec

Transform

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 any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Transform()

Abstract Value Members

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

    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: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

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

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

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

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  8. def as[A, B](fa: F[A])(implicit as: Transformer[A, B]): F[B]

    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.

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. def clone(): AnyRef

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    AnyRef

  16. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  17. def finalize(): Unit

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

  18. def formatted(fmtstr: String): String

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

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

    Definition Classes
    AnyRef → Any

  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    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.

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

    Definition Classes
    AnyRef

  24. final def notify(): Unit

    Definition Classes
    AnyRef

  25. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  27. def toString(): String

    Definition Classes
    AnyRef → Any

  28. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    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.

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

    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).

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

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

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

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Transform[F] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (transform: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Transform[F] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (transform: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

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

    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

  2. def x: Transform[F]

    Implicit information
    This member is added by an implicit conversion from Transform[F] to ArrowAssoc[Transform[F]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (transform: ArrowAssoc[Transform[F]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  3. def x: Transform[F]

    Implicit information
    This member is added by an implicit conversion from Transform[F] to Ensuring[Transform[F]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (transform: Ensuring[Transform[F]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Transform[F] to StringAdd

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

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

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

Ungrouped