com.avsystem.commons.serialization.transientDefault.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons-core_2.13 Show documentation

AVSystem commons library for Scala

There is a newer version: 2.22.0

package com.avsystem.commons
package serialization

/**
  * If some case class field has default value or [[whenAbsent]] annotation, you can use [[transientDefault]]
  * on this field to instruct an automatically derived `GenCodec` to not persist the value of that field if
  * it's equal to the default value.
  *
  * For example:
  * {{{
  *   case class Something(str: String, @transientDefault int: Int = 42)
  *   object Something {
  *     implicit val codec = GenCodec.auto[Something]
  *   }
  * }}}
  *
  * `GenCodec.write(someOutput, Something("lol", 10))` would yield object `{"str": "lol", "int": 10}` but
  * `GenCodec.write(someOutput, Something("lol", 42))` would yield object `{"str": "lol"}` because the value of `int`
  * is the same as the default value.
  *
  * NOTE: [[transientDefault]] also works for method parameters in RPC framework.
  */
class transientDefault extends StaticAnnotation