reactivemongo.bson.Macros.Options

UnionType

trait UnionType[Types <: \/[_, _]] extends SaveClassName with Default

Use type parameter A as static type but use pattern matching to handle different possible subtypes. This makes it easy to persist algebraic data types(pattern where you have a sealed trait and several implementing case classes). When writing a case class into BSON its dynamic type will be pattern matched, when reading from BSON the pattern matching will be done on the className string. This option extends reactivemongo.bson.Macros.Options.SaveClassName in to ensure class names are always serialized.

If there are handlers available in implicit scope for any of the types in the union they will be used to handle (de)serialization, otherwise handlers for all types will be generated.

You can also use case object but you have to refer to their types as to singleton types. e.g. case object MyObject, type would be MyObject.type

Example

sealed trait Tree
case class Node(left: Tree, right: Tree) extends Tree
case class Leaf(data: String) extends Tree

import Macros.Options._
implicit val treeHandler = Macros.handlerOpts[Tree, UnionType[Node \/ Leaf]]
Types

to use in pattern matching. Listed in a "type list" \/

Linear Supertypes
SaveClassName, Default, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. UnionType
  2. SaveClassName
  3. Default
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from UnionType[Types] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (UnionType[Types], B)

    Implicit information
    This member is added by an implicit conversion from UnionType[Types] to ArrowAssoc[UnionType[Types]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (UnionType[Types]) ⇒ Boolean, msg: ⇒ Any): UnionType[Types]

    Implicit information
    This member is added by an implicit conversion from UnionType[Types] to Ensuring[UnionType[Types]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (UnionType[Types]) ⇒ Boolean): UnionType[Types]

    Implicit information
    This member is added by an implicit conversion from UnionType[Types] to Ensuring[UnionType[Types]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): UnionType[Types]

    Implicit information
    This member is added by an implicit conversion from UnionType[Types] to Ensuring[UnionType[Types]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): UnionType[Types]

    Implicit information
    This member is added by an implicit conversion from UnionType[Types] to Ensuring[UnionType[Types]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from UnionType[Types] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

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

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

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

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

    Definition Classes
    AnyRef
  25. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def [B](y: B): (UnionType[Types], B)

    Implicit information
    This member is added by an implicit conversion from UnionType[Types] to ArrowAssoc[UnionType[Types]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from UnionType[Types] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (unionType: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from UnionType[Types] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (unionType: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: UnionType[Types]

    Implicit information
    This member is added by an implicit conversion from UnionType[Types] to ArrowAssoc[UnionType[Types]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (unionType: ArrowAssoc[UnionType[Types]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: UnionType[Types]

    Implicit information
    This member is added by an implicit conversion from UnionType[Types] to Ensuring[UnionType[Types]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (unionType: Ensuring[UnionType[Types]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from SaveClassName

Inherited from Default

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from UnionType[Types] to StringAdd

Inherited by implicit conversion any2stringfmt from UnionType[Types] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from UnionType[Types] to ArrowAssoc[UnionType[Types]]

Inherited by implicit conversion any2Ensuring from UnionType[Types] to Ensuring[UnionType[Types]]

Ungrouped