Type Members

1.  final case class Codec[Domain, Dto](encode: Transformer[Domain, Dto], decode: PartialTransformer[Dto, Domain]) extends Product with Serializable

   Type class representing bidirectional conversion from the type that can be always converted (total transformation), usually the domain model, into type that has to be validated when converting back (partial transformation), usually the DTO model.

   Type class representing bidirectional conversion from the type that can be always converted (total transformation), usually the domain model, into type that has to be validated when converting back (partial transformation), usually the DTO model.

   Domain

   type of the domain value

   Dto

   typeof the DTO value

   encode

   conversion from domain model to DTO which is guaranteed to succeed

   decode

   conversion from DTO to domain model which can fail

   Since

   1.2.0

   See also

   https://chimney.readthedocs.io/cookbook/#bidirectional-transformations

2.  final case class Iso[First, Second](first: Transformer[First, Second], second: Transformer[Second, First]) extends Product with Serializable

   Type class representing bidirectional conversion between isomorphic types, where conversion in each can always succeed (total transformation).

   Type class representing bidirectional conversion between isomorphic types, where conversion in each can always succeed (total transformation).

   First

   input type of the first conversion, output type of the second conversion

   Second

   output type of the first conversion, input type of the second conversion

   first

   conversion the first type into the second type

   second

   conversion the second type into the first type

   Since

   1.2.0

   See also

   https://chimney.readthedocs.io/cookbook/#bidirectional-transformations

3.  trait PartialTransformer[From, To] extends AutoDerived[From, To]

   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

   Annotations

   @FunctionalInterface()

   Since

   0.7.0

   See also

   https://chimney.readthedocs.io/supported-transformations/

   https://chimney.readthedocs.io/supported-transformations/#total-transformers-vs-partialtransformers

4.  trait Patcher[A, Patch] extends AutoDerived[A, Patch]

   Type class definition that wraps patching behavior.

   Type class definition that wraps patching behavior.

   A

   type of object to apply patch to

   Patch

   type of patch object

   Annotations

   @FunctionalInterface()

   Since

   0.1.3

   See also

   https://chimney.readthedocs.io/supported-patching/

5.  trait Transformer[From, To] extends AutoDerived[From, To]

   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

   Annotations

   @FunctionalInterface()

   Since

   0.1.0

   See also

   https://chimney.readthedocs.io/supported-transformations/

   https://chimney.readthedocs.io/supported-transformations/#total-transformers-vs-partialtransformers