Packages

object Macros

Macro based Codecs

Allows the compile time creation of Codecs for case classes.

The recommended approach is to use the implicit Macros.createCodecProvider method to help build a codecRegistry: import org.mongodb.scala.bson.codecs.Macros.createCodecProvider import org.bson.codecs.configuration.CodecRegistries.{fromRegistries, fromProviders}

case class Contact(phone: String) case class User(_id: Int, username: String, age: Int, hobbies: List[String], contacts: List[Contact])

val codecRegistry = fromRegistries(fromProviders(classOf[User], classOf[Contact]), MongoClient.DEFAULT_CODEC_REGISTRY)

Since

2.0

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Macros
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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 clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. macro def createCodec[T](codecRegistry: CodecRegistry): Codec[T]

    Creates a Codec for a case class

    Creates a Codec for a case class

    T

    the case class to create a codec from

    codecRegistry

    the Codec Registry to use

    returns

    the Codec for the case class

    Annotations
    @compileTimeOnly( ... )
  7. macro def createCodec[T](): Codec[T]

    Creates a Codec for a case class

    Creates a Codec for a case class

    T

    the case class to create a Codec from

    returns

    the Codec for the case class

    Annotations
    @compileTimeOnly( ... )
  8. implicit macro def createCodecProvider[T](clazz: Class[T]): CodecProvider

    Creates a CodecProvider for a case class using the given class to represent the case class

    Creates a CodecProvider for a case class using the given class to represent the case class

    T

    the case class to create a Codec from

    clazz

    the clazz that is the case class

    returns

    the CodecProvider for the case class

    Annotations
    @compileTimeOnly( ... )
  9. macro def createCodecProvider[T](): CodecProvider

    Creates a CodecProvider for a case class

    Creates a CodecProvider for a case class

    T

    the case class to create a Codec from

    returns

    the CodecProvider for the case class

    Annotations
    @compileTimeOnly( ... )
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped