Packages

c

io.scalaland.chimney.dsl

PatcherUsing

final class PatcherUsing[A, Patch, Cfg <: PatcherCfg, Flags <: PatcherFlags] extends PatcherFlagsDsl[[Flags1]PatcherUsing[A, Patch, Cfg, Flags1], Flags]

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

Cfg

type-level encoded config

Flags

type-level encoded flags

Since

0.4.0

Linear Supertypes
PatcherFlagsDsl[[Flags1]PatcherUsing[A, Patch, Cfg, Flags1], Flags], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PatcherUsing
  2. PatcherFlagsDsl
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PatcherUsing(obj: A, objPatch: Patch)

    obj

    object to patch

    objPatch

    patch object

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clearOnNoneInPatch: PatcherUsing[A, Patch, Cfg, Disable[IgnoreNoneInPatch, Flags]]

    Then there Option is patching Option, on None value will be cleared.

    Then there Option is patching Option, on None value will be cleared.

    returns

    io.scalaland.chimney.dsl.PatcherUsing

    Definition Classes
    PatcherFlagsDsl
    Since

    0.8.0

    See also

    https://chimney.readthedocs.io/supported-patching/#treating-none-as-no-update-instead-of-set-to-none for more details

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def disableMacrosLogging: PatcherUsing[A, Patch, Cfg, Disable[MacrosLogging, Flags]]

    Disable printing the logs from the derivation process.

    Disable printing the logs from the derivation process.

    Definition Classes
    PatcherFlagsDsl
    Since

    0.8.0

    See also

    https://chimney.readthedocs.io/troubleshooting/#debugging-macros for more details

  8. def enableMacrosLogging: PatcherUsing[A, Patch, Cfg, Enable[MacrosLogging, Flags]]

    Enable printing the logs from the derivation process.

    Enable printing the logs from the derivation process.

    Definition Classes
    PatcherFlagsDsl
    Since

    0.8.0

    See also

    https://chimney.readthedocs.io/troubleshooting/#debugging-macros for more details

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def failRedundantPatcherFields: PatcherUsing[A, Patch, Cfg, Disable[IgnoreRedundantPatcherFields, Flags]]

    Fail the compilation if there is a redundant field in patching object.

    Fail the compilation if there is a redundant field in patching object.

    returns

    io.scalaland.chimney.dsl.PatcherUsing

    Definition Classes
    PatcherFlagsDsl
    Since

    0.8.0

    See also

    https://chimney.readthedocs.io/supported-patching/#ignoring-fields-in-patches for more details

  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def ignoreNoneInPatch: PatcherUsing[A, Patch, Cfg, Enable[IgnoreNoneInPatch, Flags]]

    In case when both object to patch and patch value contain field of type Option[T], this option allows to treat None value in patch like the value was not provided.

    In case when both object to patch and patch value contain field of type Option[T], this option allows to treat None value in patch like the value was not provided.

    By default, when None is delivered in patch, Chimney clears the value of such field on patching.

    returns

    io.scalaland.chimney.dsl.PatcherUsing

    Definition Classes
    PatcherFlagsDsl
    Since

    0.4.0

    See also

    https://chimney.readthedocs.io/supported-patching/#treating-none-as-no-update-instead-of-set-to-none for more details

  16. def ignoreRedundantPatcherFields: PatcherUsing[A, Patch, Cfg, Enable[IgnoreRedundantPatcherFields, Flags]]

    In case that patch object contains a redundant field (i.e.

    In case that patch object contains a redundant field (i.e. field that is not present in patched object type), this option enables ignoring value of such fields and generate patch successfully.

    By default, when Chimney detects a redundant field in patch object, it fails the compilation in order to prevent silent oversight of field name typos.

    returns

    io.scalaland.chimney.dsl.PatcherUsing

    Definition Classes
    PatcherFlagsDsl
    Since

    0.4.0

    See also

    https://chimney.readthedocs.io/supported-patching/#ignoring-fields-in-patches for more details

  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. val obj: A
  22. val objPatch: Patch
  23. macro def patch[ImplicitScopeFlags <: PatcherFlags](implicit tc: PatcherConfiguration[ImplicitScopeFlags]): A

    Applies configured patching in-place

    Applies configured patching in-place

    returns

    patched value

    Since

    0.4.0

  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from PatcherFlagsDsl[[Flags1]PatcherUsing[A, Patch, Cfg, Flags1], Flags]

Inherited from AnyRef

Inherited from Any

Ungrouped