Trait/Object

io.scalaland.chimney

TransformerFSupport

Related Docs: object TransformerFSupport | package chimney

Permalink

trait TransformerFSupport[F[+_]] extends AnyRef

Type class supporting lifted transformers.

In order to create lifted transformation from A to F[B], we need these few operations to be implemented for specific F wrapper type.

F

wrapper type constructor

See also

TransformerFSupport.TransformerFEitherErrorAccumulatingSupport for implementation for Either

TransformerFSupport.TransformerFOptionSupport for implementation for Option

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TransformerFSupport
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

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

    Permalink

    Transform wrapped value with given function.

    Transform wrapped value with given function.

    A

    type of wrapped value

    B

    result type of provided function f

    fa

    wrapped value

    f

    function

    returns

    wrapped result of function f applied to un

  2. abstract def product[A, B](fa: F[A], fb: ⇒ F[B]): F[(A, B)]

    Permalink

    Combine two wrapped values into wrapped pair of them.

    Combine two wrapped values into wrapped pair of them.

    This method allows to decide on error handling semantics for given type F.

    A

    type of first value

    B

    type of second value

    fa

    first wrapped value

    fb

    second wrapped value

    returns

    wrapped pair of values

  3. abstract def pure[A](value: A): F[A]

    Permalink

    Wrap a value into the type constructor F.

    Wrap a value into the type constructor F.

    A

    type of value

    value

    value to wrap

    returns

    wrapped value

  4. abstract def traverse[M, A, B](it: Iterator[A], f: (A) ⇒ F[B])(implicit fac: scala.collection.compat.Factory[B, M]): F[M]

    Permalink

    Perform traversal of function f on provided iterator of elements.

    Perform traversal of function f on provided iterator of elements.

    Primarily used to perform recursive lifted transformation (given as function f) on a collection type (Array, Seq, List, Vector, Map, etc.) for which we can obtain an Iterator[A].

    This method allows to decide on error handling semantics for given type F, when transforming between collections.

    M

    type of collection where transformed elements are stored; note that this is not a type constructor, but a type with applied argument, so it can be List[B], Map[K, V], etc.

    A

    type of elements being iterated

    B

    target element type of function f

    it

    iterator of elements of type A

    f

    function to apply to elements of type A, returning F[B]

    fac

    factory for collection type M

    returns

    wrapped collection of type F[M]

Concrete Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  15. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(): Unit

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

Deprecated Value Members

  1. def finalize(): Unit

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped