Trait

reactivemongo.bson.Macros.Options

UnionType

Related Doc: package Options

Permalink

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
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. UnionType
  2. SaveClassName
  3. Default
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Value Members

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

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

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

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

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

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

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

Inherited from SaveClassName

Inherited from Default

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped