trait NameAdapter extends (String) => String

Adapter function to transform case classes member names during the derivation process

A NameAdapter can be used to customize the derivation process, allowing to apply a transformation function to case classes member names when deriving serializers/deserializers

For instance, it can be used to derive serializers/deserializers that use a different casing for the json keys.

For example, to derive a Format[A] that uses snake_case for the json keys (using the predefined NameAdapter.snakeCase)

import julienrf.json.derived
import julienrf.json.derived.NameAdapter
import play.api.libs.json.{Format, Json}

case class Bar(camelCase: String)
object Bar {
  implicit val format: Format[Bar] = derived.oformat[Bar](NameAdapter.snakeCase)
}
scala> Json.toJson(Bar("a json value"))
res0: play.api.libs.json.JsValue = {"camel_case":"a json value"}

scala> Json.fromJson[Bar](Json.parse("""{"camel_case":"a json value"}"""))
res1: play.api.libs.json.JsResult[Bar] = JsSuccess(Bar(a json value),)
Linear Supertypes
(String) => String, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NameAdapter
  2. Function1
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def apply(v1: String): String
    Definition Classes
    Function1

Concrete 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. def andThen[A](g: (String) => A): (String) => A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def compose[A](g: (A) => String): (A) => String
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    Function1 → AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from (String) => String

Inherited from AnyRef

Inherited from Any

Ungrouped