Macros

Type Members

final class LocalVar[T] extends AnyRef

Only for internal purposes
sealed trait Options extends AnyRef

Macros with 'Opts' suffix will take additional options in the form of type parameters that will customize behaviour of the macros during compilation.
final class Placeholder extends AnyRef

Only for internal purposes
final class WithOptions[Opts <: Options] extends AnyRef

Macros for generating BSONReader and BSONWriter at compile time, with given options.

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
object Annotations

Annotations to use on case classes that are being processed by macros.
object Options
object Placeholder

Only for internal purposes
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )

def configured[Opts <: Options](implicit config: Aux[Opts]): WithOptions[Opts]

Returns macros using the current BSON configuration.

Opts

the compile-time options

import reactivemongo.api.bson.{
  BSONDocumentReader, MacroConfiguration, Macros
}
// Materializes a `BSONDocumentReader[Foo]`,
// with the configuration resolved at compile time
val r1: BSONDocumentReader[Foo] = Macros.configured.reader[Foo]
val r2: BSONDocumentReader[Foo] = Macros.configured(
  MacroConfiguration.simpleTypeName).reader[Foo]

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
macro def handler[A]: BSONDocumentHandler[A]

Creates a BSONDocumentHandler for type A.
Creates a BSONDocumentHandler for type A.
A
the type of the value represented as BSON

Annotations
@SuppressWarnings()
macro def handlerOpts[A, Opts <: Default]: BSONDocumentHandler[A]

Creates a BSONDocumentHandler for type A and takes additional options.
Creates a BSONDocumentHandler for type A and takes additional options.
A
the type of the value represented as BSON
Opts
the compile-time options

Annotations
@SuppressWarnings()
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
macro def reader[A]: BSONDocumentReader[A]

Creates a BSONDocumentReader for type A.
Creates a BSONDocumentReader for type A.
A
the type of the value represented as BSON

Annotations
@SuppressWarnings()
macro def readerOpts[A, Opts <: Default]: BSONDocumentReader[A]

Creates a BSONDocumentReader for type A and takes additional options.
Creates a BSONDocumentReader for type A and takes additional options.
A
the type of the value represented as BSON
Opts
the compile-time options

Annotations
@SuppressWarnings()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def using[Opts <: Options]: WithOptions[Opts]

Returns an inference context to call the BSON macros, using explicit compile-time options.
Returns an inference context to call the BSON macros, using explicit compile-time options.
Opts
the compile-time options
```
import reactivemongo.api.bson.{
  BSONDocumentReader, MacroConfiguration, Macros
}
val w: BSONDocumentWriter[Bar] =
  Macros.using[Options.Default].writer[Bar]
```
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( ... )
macro def writer[A]: BSONDocumentWriter[A]

Creates a BSONDocumentWriter for type A.
Creates a BSONDocumentWriter for type A.
A
the type of the value represented as BSON

Annotations
@SuppressWarnings()
macro def writerOpts[A, Opts <: Default]: BSONDocumentWriter[A]

Creates a BSONDocumentWriter for type A and takes additional options.
Creates a BSONDocumentWriter for type A and takes additional options.
A
the type of the value represented as BSON
Opts
the compile-time options

Annotations
@SuppressWarnings()

Related Doc: package bson

object Macros

Type Members

final class LocalVar[T] extends AnyRef

sealed trait Options extends AnyRef

final class Placeholder extends AnyRef

final class WithOptions[Opts <: Options] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Annotations

object Options

object Placeholder

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def configured[Opts <: Options](implicit config: Aux[Opts]): WithOptions[Opts]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

macro def handler[A]: BSONDocumentHandler[A]

macro def handlerOpts[A, Opts <: Default]: BSONDocumentHandler[A]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

macro def reader[A]: BSONDocumentReader[A]

macro def readerOpts[A, Opts <: Default]: BSONDocumentReader[A]

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

def toString(): String

def using[Opts <: Options]: WithOptions[Opts]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

macro def writer[A]: BSONDocumentWriter[A]

macro def writerOpts[A, Opts <: Default]: BSONDocumentWriter[A]

Inherited from AnyRef

Inherited from Any

Ungrouped