Macros

Macro based Codecs

Allows the compile time creation of Codecs for case classes.

The recommended approach is to use the implicit Macros.createCodecProvider[T](clazz:Class[T])* 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

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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( ... )
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( ... )
macro def createCodecIgnoreNone[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( ... )
Since
2.1
macro def createCodecIgnoreNone[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( ... )
Since
2.1
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( ... )
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( ... )
macro def createCodecProviderIgnoreNone[T](clazz: Class[T]): CodecProvider

Creates a CodecProvider for a case class that ignores any None values, using the given class to represent the case class
Creates a CodecProvider for a case class that ignores any None values, 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( ... )
Since
2.1
macro def createCodecProviderIgnoreNone[T](): CodecProvider

Creates a CodecProvider for a case class that ignores any None values
Creates a CodecProvider for a case class that ignores any None values
T
the case class to create a Codec from
returns
the CodecProvider for the case class

Annotations
@compileTimeOnly( ... )
Since
2.1
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package codecs

object Macros

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

macro def createCodec[T](codecRegistry: CodecRegistry): Codec[T]

macro def createCodec[T](): Codec[T]

macro def createCodecIgnoreNone[T](codecRegistry: CodecRegistry): Codec[T]

macro def createCodecIgnoreNone[T](): Codec[T]

implicit macro def createCodecProvider[T](clazz: Class[T]): CodecProvider

macro def createCodecProvider[T](): CodecProvider

macro def createCodecProviderIgnoreNone[T](clazz: Class[T]): CodecProvider

macro def createCodecProviderIgnoreNone[T](): CodecProvider

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped