Packages

package chimney

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Package Members

  1. package dsl

    Main object to import in order to use Chimney's features

    Main object to import in order to use Chimney's features

    Since

    0.1.0

  2. package partial

Type Members

  1. trait PartialTransformer[From, To] extends AnyRef

    Type class expressing partial transformation between source type From and target type To, with the ability of reporting path-annotated transformation error(s).

    Type class expressing partial transformation between source type From and target type To, with the ability of reporting path-annotated transformation error(s).

    From

    type of input value

    To

    type of output value

    Since

    0.7.0

  2. trait Patcher[T, Patch] extends AnyRef

    Type class definition that wraps patching behavior.

    Type class definition that wraps patching behavior.

    T

    type of object to apply patch to

    Patch

    type of patch object

    Since

    0.1.3

  3. trait Transformer[From, To] extends AnyRef

    Type class expressing total transformation between source type From and target type To.

    Type class expressing total transformation between source type From and target type To.

    From

    type of input value

    To

    type of output value

    Since

    0.1.0

Deprecated Type Members

  1. sealed trait ErrorPathNode extends AnyRef

    Path segment for io.scalaland.chimney.TransformerF

    Path segment for io.scalaland.chimney.TransformerF

    Annotations
    @deprecated
    Deprecated

    (Since version Chimney 0.7.0) Lifted transformers are deprecated. Consider using PartialTransformer.

    Since

    0.6.1

    See also

    io.scalaland.chimney.TransformerFErrorPathSupport

  2. final case class TransformationError[M](message: M, errorPath: List[ErrorPathNode] = Nil) extends Product with Serializable

    Default implementation of error with path info

    Default implementation of error with path info

    M

    type of error message

    message

    error message value

    errorPath

    error location

    Annotations
    @deprecated
    Deprecated

    (Since version Chimney 0.7.0) Lifted transformers are deprecated. Consider using PartialTransformer.

    Since

    0.6.1

  3. trait TransformerF[F[+_], From, To] extends AnyRef

    Type class expressing partial transformation between source type From and target type To, wrapping transformation result in type constructor F.

    Type class expressing partial transformation between source type From and target type To, wrapping transformation result in type constructor F.

    Useful for validated transformations, where result type is wrapped in Option, Either, Validated, etc...

    F

    wrapper type constructor

    From

    type of input value

    To

    type of output value

    Annotations
    @deprecated
    Deprecated

    (Since version Chimney 0.7.0) Lifted transformers are deprecated. Consider using PartialTransformer.

    Since

    0.5.0

    See also

    io.scalaland.chimney.TransformerFSupport

  4. trait TransformerFErrorPathSupport[F[+_]] extends AnyRef

    Type class adding support or error path for lifted transformers.

    Type class adding support or error path for lifted transformers.

    If you implement it, you will be able to get path of each error in transformation.

    F

    wrapper type constructor

    Annotations
    @deprecated
    Deprecated

    (Since version Chimney 0.7.0) Lifted transformers are deprecated. Consider using PartialTransformer.

    Since

    0.6.1

    See also

    TransformerFErrorPathSupport.TransformerFErrorPathEitherSupport for implementation for Either[C[TransformationError], +*]

  5. trait TransformerFSupport[F[+_]] extends AnyRef

    Type class supporting lifted transformers.

    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

    Annotations
    @deprecated
    Deprecated

    (Since version Chimney 0.7.0) Lifted transformers are deprecated. Consider using PartialTransformer.

    Since

    0.5.0

    See also

    TransformerFSupport.TransformerFOptionSupport for implementation for Option

    TransformerFSupport.TransformerFEitherErrorAccumulatingSupport for implementation for Either

Value Members

  1. object PartialTransformer
  2. object Patcher

    Since

    0.1.3

  3. object Transformer

Deprecated Value Members

  1. object ErrorPathNode

    Annotations
    @deprecated
    Deprecated

    (Since version Chimney 0.7.0) Lifted transformers are deprecated. Consider using PartialTransformer.

    Since

    0.6.1

  2. object TransformerF
    Annotations
    @deprecated
    Deprecated

    (Since version Chimney 0.7.0) Lifted transformers are deprecated. Consider using PartialTransformer.

  3. object TransformerFErrorPathSupport

    Annotations
    @deprecated
    Deprecated

    (Since version Chimney 0.7.0) Lifted transformers are deprecated. Consider using PartialTransformer.

    Since

    0.6.1

  4. object TransformerFSupport

    Annotations
    @deprecated
    Deprecated

    (Since version Chimney 0.7.0) Lifted transformers are deprecated. Consider using PartialTransformer.

    Since

    0.5.0

Ungrouped