package dsl
Main object to import in order to use Chimney's features
- Since
0.1.0
- Alphabetic
- By Inheritance
- dsl
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
final
class
CodecDefinition[Domain, Dto, EncodeOverrides <: TransformerOverrides, DecodeOverrides <: TransformerOverrides, Flags <: TransformerFlags] extends TransformerFlagsDsl[[Flags1]CodecDefinition[Domain, Dto, EncodeOverrides, DecodeOverrides, Flags1], Flags]
Allows customization of io.scalaland.chimney.Codec derivation.
Allows customization of io.scalaland.chimney.Codec derivation.
- Domain
type of the domain value
- Dto
typeof the DTO value
- EncodeOverrides
type-level encoded config
- DecodeOverrides
type-level encoded config
- Flags
type-level encoded flags
- Since
1.2.0
-
sealed abstract
class
ImplicitTransformerPreference extends AnyRef
Whether derivation should prefer total or partial transformers if both are provided for some field transformation.
Whether derivation should prefer total or partial transformers if both are provided for some field transformation.
- Since
0.7.0
- See also
https://chimney.readthedocs.io/supported-transformations/#resolving-priority-of-implicit-total-vs-partial-transformers for more details
-
final
class
IsoDefinition[First, Second, FirstOverrides <: TransformerOverrides, SecondOverrides <: TransformerOverrides, Flags <: TransformerFlags] extends TransformerFlagsDsl[[Flags1]IsoDefinition[First, Second, FirstOverrides, SecondOverrides, Flags1], Flags]
Allows customization of io.scalaland.chimney.Iso derivation.
Allows customization of io.scalaland.chimney.Iso derivation.
- 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
- FirstOverrides
type-level encoded config
- SecondOverrides
type-level encoded config
- Flags
type-level encoded flags
- Since
1.2.0
-
final
class
PartialTransformerDefinition[From, To, Overrides <: TransformerOverrides, Flags <: TransformerFlags] extends TransformerFlagsDsl[[Flags1]PartialTransformerDefinition[From, To, Overrides, Flags1], Flags] with TransformerDefinitionCommons[[Overrides1]PartialTransformerDefinition[From, To, Overrides1, Flags]] with WithRuntimeDataStore
Allows customization of io.scalaland.chimney.PartialTransformer derivation.
Allows customization of io.scalaland.chimney.PartialTransformer derivation.
- From
type of input value
- To
type of output value
- Overrides
type-level encoded config
- Flags
type-level encoded flags
- Since
0.7.0
-
final
class
PartialTransformerInto[From, To, Overrides <: TransformerOverrides, Flags <: TransformerFlags] extends TransformerFlagsDsl[[Flags1]PartialTransformerInto[From, To, Overrides, Flags1], Flags] with WithRuntimeDataStore
Provides DSL for configuring io.scalaland.chimney.PartialTransformer's generation and using the result to transform value at the same time
Provides DSL for configuring io.scalaland.chimney.PartialTransformer's generation and using the result to transform value at the same time
- From
type of input value
- To
type of output value
- Overrides
type-level encoded config
- Flags
type-level encoded flags
- Since
0.7.0
-
implicit final
class
PartialTransformerOps[From] extends AnyVal
Provides partial transformer operations on values of any type.
Provides partial transformer operations on values of any type.
- From
type of source value
- Since
0.7.0
-
final
class
PatcherConfiguration[Flags <: PatcherFlags] extends PatcherFlagsDsl[UpdateFlag, Flags]
Type-level set of derivation flags that can be shared between derivations through implicit scope.
Type-level set of derivation flags that can be shared between derivations through implicit scope.
- Flags
type-level encoded flags
- Since
0.8.0
- See also
https://chimney.readthedocs.io/cookbook/#reusing-flags-for-several-transformationspatchings for more details
-
final
class
PatcherDefinition[From, To, Overrides <: PatcherOverrides, Flags <: PatcherFlags] extends PatcherFlagsDsl[[Flags1]PatcherDefinition[From, To, Overrides, Flags1], Flags]
Allows customization of io.scalaland.chimney.Patcher derivation.
Allows customization of io.scalaland.chimney.Patcher derivation.
- Overrides
type-level encoded config
- Flags
type-level encoded flags
- Since
0.8.0
-
implicit final
class
PatcherOps[A] extends AnyVal
Provides patcher operations on values of any type
Provides patcher operations on values of any type
- A
type of object to patch
- Since
0.1.3
-
final
class
PatcherUsing[A, Patch, Overrides <: PatcherOverrides, Flags <: PatcherFlags] extends PatcherFlagsDsl[[Flags1]PatcherUsing[A, Patch, Overrides, Flags1], Flags]
Provides operations to customize io.scalaland.chimney.Patcher logic for specific object value and patch value.
Provides operations to customize io.scalaland.chimney.Patcher logic for specific object value and patch value.
- A
type of object to apply patch to
- Patch
type of patch object
- Overrides
type-level encoded config
- Flags
type-level encoded flags
- Since
0.4.0
-
abstract
class
TransformedNamesComparison extends AnyRef
Provides a way of customizing how fields/subtypes shoud get matched betwen source value and target value.
Provides a way of customizing how fields/subtypes shoud get matched betwen source value and target value.
- Since
1.0.0
- See also
https://chimney.readthedocs.io/supported-transformations/#defining-custom-name-matching-predicate for more details
-
final
class
TransformerConfiguration[Flags <: TransformerFlags] extends TransformerFlagsDsl[UpdateFlag, Flags]
Type-level set of derivation flags that can be shared between derivations through implicit scope.
Type-level set of derivation flags that can be shared between derivations through implicit scope.
- Flags
type-level encoded flags
- Since
0.6.0
- See also
https://chimney.readthedocs.io/cookbook/#reusing-flags-for-several-transformationspatchings for more details
-
final
class
TransformerDefinition[From, To, Overrides <: TransformerOverrides, Flags <: TransformerFlags] extends TransformerFlagsDsl[[Flags1]TransformerDefinition[From, To, Overrides, Flags1], Flags] with TransformerDefinitionCommons[[Overrides1]TransformerDefinition[From, To, Overrides1, Flags]] with WithRuntimeDataStore
Allows customization of io.scalaland.chimney.Transformer derivation.
Allows customization of io.scalaland.chimney.Transformer derivation.
- From
type of input value
- To
type of output value
- Overrides
type-level encoded config
- Flags
type-level encoded flags
- Since
0.4.0
-
final
class
TransformerInto[From, To, Overrides <: TransformerOverrides, Flags <: TransformerFlags] extends TransformerFlagsDsl[[Flags1]TransformerInto[From, To, Overrides, Flags1], Flags] with WithRuntimeDataStore
Provides DSL for configuring io.scalaland.chimney.Transformer's generation and using the result to transform value at the same time
Provides DSL for configuring io.scalaland.chimney.Transformer's generation and using the result to transform value at the same time
- From
type of input value
- To
type of output value
- Overrides
type-level encoded config
- Flags
type-level encoded flags
- Since
0.1.0
-
implicit final
class
TransformerOps[From] extends AnyVal
Provides transformer operations on values of any type.
Provides transformer operations on values of any type.
- From
type of source value
- Since
0.4.0
Value Members
- implicit def EitherStringPartialTransformerOps[A](either: Either[String, A]): EitherStringPartialTransformerOps[A]
- implicit def OptionPartialTransformerOps[A](option: Option[A]): OptionPartialTransformerOps[A]
- implicit def PartialTransformationOps[From](from: From): PartialTransformationOps[From]
- implicit def PatchingOps[A](obj: A): PatchingOps[A]
- implicit def TransformationCollectionPathOps[C[_], A](a: C[A]): TransformationCollectionPathOps[C, A]
- implicit def TransformationMapPathOps[M[_, _], K, V](a: M[K, V]): TransformationMapPathOps[M, K, V]
- implicit def TransformationMatchingPathOps[A](a: A): TransformationMatchingPathOps[A]
- implicit def TransformationOps[From](from: From): TransformationOps[From]
- implicit def TryPartialTransformerOps[A](try: Try[A]): TryPartialTransformerOps[A]
-
object
PatcherConfiguration
- Since
0.8.0
-
object
PreferPartialTransformer extends ImplicitTransformerPreference with Product with Serializable
Tell the derivation to prefer partial transformers.
Tell the derivation to prefer partial transformers.
- Since
0.7.0
- See also
https://chimney.readthedocs.io/supported-transformations/#resolving-priority-of-implicit-total-vs-partial-transformers for more details
-
object
PreferTotalTransformer extends ImplicitTransformerPreference with Product with Serializable
Tell the derivation to prefer total transformers.
Tell the derivation to prefer total transformers.
- Since
0.7.0
- See also
https://chimney.readthedocs.io/supported-transformations/#resolving-priority-of-implicit-total-vs-partial-transformers for more details
-
object
TransformedNamesComparison
- Since
1.0.0
-
object
TransformerConfiguration
- Since
0.6.0
- object TransformerDefinitionCommons