• Home
• com.avsystem.commons
• commons-core_2.12
• 2.11.0
• source code
• transientDefault.scala

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

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