Packages

  • package root
    Definition Classes
    root
  • package reactivemongo
    Definition Classes
    root
  • package bson
    Definition Classes
    reactivemongo
  • object Macros

    Macros for generating BSONReader and BSONWriter implementations for case at compile time.

    Macros for generating BSONReader and BSONWriter implementations for case at compile time. Invoking these macros is equivalent to writing anonymous class implementations by hand.

    import reactivemongo.bson.Macros

case class Person(name: String, surname: String)
implicit val personHandler = Macros.handler[Person]
    Definition Classes
    bson
    See also

    Macros.Options for specific options

  • object Annotations

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

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

    Definition Classes
    Macros
  • Flatten
  • Ignore
  • Key
  • NoneAsNull

case class Key(key: String) extends Annotation with StaticAnnotation with Product with Serializable

Specify a key different from field name in your case class. Convenient to use when you'd like to leverage mongo's _id index but don't want to actually use _id in your code.

import reactivemongo.bson.Macros.Annotations.Key

case class Website(@Key("_id") url: String)

Generated handler will map the url field in your code to _id field in BSON

key

the desired key to use in BSON

Annotations
@param()
Linear Supertypes
Serializable, Product, Equals, StaticAnnotation, Annotation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Key
  2. Serializable
  3. Product
  4. Equals
  5. StaticAnnotation
  6. Annotation
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Key(key: String)

    key

    the desired key to use in BSON

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Key toany2stringadd[Key] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Key, B)
    Implicit
    This member is added by an implicit conversion from Key toArrowAssoc[Key] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (Key) => Boolean, msg: => Any): Key
    Implicit
    This member is added by an implicit conversion from Key toEnsuring[Key] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Key) => Boolean): Key
    Implicit
    This member is added by an implicit conversion from Key toEnsuring[Key] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Key
    Implicit
    This member is added by an implicit conversion from Key toEnsuring[Key] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Key
    Implicit
    This member is added by an implicit conversion from Key toEnsuring[Key] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Key toStringFormat[Key] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val key: String
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def →[B](y: B): (Key, B)
    Implicit
    This member is added by an implicit conversion from Key toArrowAssoc[Key] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromKey to any2stringadd[Key]

Inherited by implicit conversion StringFormat fromKey to StringFormat[Key]

Inherited by implicit conversion Ensuring fromKey to Ensuring[Key]

Inherited by implicit conversion ArrowAssoc fromKey to ArrowAssoc[Key]

Ungrouped