Packages

sealed abstract class BSONObjectID extends BSONValue

BSON ObjectId value.

import scala.util.Try
import reactivemongo.api.bson.BSONObjectID

val oid: BSONObjectID = BSONObjectID.generate()

def foo: Try[BSONObjectID] = BSONObjectID.parse(oid.stringify)

| Timestamp (seconds) | Machine identifier | Thread identifier | Increment

| --- | --- | --- | ---

| 4 bytes | 3 bytes | 2 bytes | 3 bytes

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BSONObjectID
  2. BSONValue
  3. AnyRef
  4. Any
Implicitly
  1. by identityValueProducer
  2. by valueProducer
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract val raw: Array[Byte]
    Attributes
    protected
  2. abstract def timeSecond: Int

    The time of this BSONObjectId, in seconds

Concrete 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 BSONObjectID toany2stringadd[BSONObjectID] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (BSONObjectID, B)
    Implicit
    This member is added by an implicit conversion from BSONObjectID toArrowAssoc[BSONObjectID] 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. final def asOpt[T](implicit reader: BSONReader[T]): Option[T]

    Optionally parses this value as a T one.

    Optionally parses this value as a T one.

    returns

    Some successfully parsed value, or None if fails

    import reactivemongo.api.bson.BSONValue
    
    def foo(v: BSONValue): Option[String] = v.asOpt[String]
    Definition Classes
    BSONValue
    Annotations
    @inline()
  8. final def asTry[T](implicit reader: BSONReader[T]): Try[T]

    Tries to parse this value as a T one.

    Tries to parse this value as a T one.

    import scala.util.Try
    import reactivemongo.api.bson.BSONValue
    
    def foo(v: BSONValue): Try[String] = v.asTry[String]
    Definition Classes
    BSONValue
  9. final def byteArray: Array[Byte]

    Returns the whole binary content as array.

  10. val byteCode: Byte

    The code indicating the BSON type for this value as Byte

    The code indicating the BSON type for this value as Byte

    Definition Classes
    BSONObjectIDBSONValue
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  12. val code: Int

    The code indicating the BSON type for this value

    The code indicating the BSON type for this value

    Definition Classes
    BSONObjectIDBSONValue
  13. def ensuring(cond: (BSONObjectID) => Boolean, msg: => Any): BSONObjectID
    Implicit
    This member is added by an implicit conversion from BSONObjectID toEnsuring[BSONObjectID] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (BSONObjectID) => Boolean): BSONObjectID
    Implicit
    This member is added by an implicit conversion from BSONObjectID toEnsuring[BSONObjectID] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: => Any): BSONObjectID
    Implicit
    This member is added by an implicit conversion from BSONObjectID toEnsuring[BSONObjectID] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): BSONObjectID
    Implicit
    This member is added by an implicit conversion from BSONObjectID toEnsuring[BSONObjectID] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(that: Any): Boolean
    Definition Classes
    BSONObjectID → AnyRef → Any
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  20. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from BSONObjectID toStringFormat[BSONObjectID] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. lazy val hashCode: Int
    Definition Classes
    BSONObjectID → AnyRef → Any
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. lazy val stringify: String

    The hexadecimal String representation.

    The hexadecimal String representation.

    import reactivemongo.api.bson.BSONObjectID
    
    def foo(oid: BSONObjectID): scala.util.Try[BSONObjectID] = {
      val repr: String = oid.stringify
      BSONObjectID.parse(repr)
    }
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. final def time: Long

    The time of this BSONObjectId, in milliseconds

    The time of this BSONObjectId, in milliseconds

    Annotations
    @inline()
  30. def toString(): String
    Definition Classes
    BSONObjectID → AnyRef → Any
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def [B](y: B): (BSONObjectID, B)
    Implicit
    This member is added by an implicit conversion from BSONObjectID toArrowAssoc[BSONObjectID] 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 BSONValue

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion identityValueProducer fromBSONObjectID to Producer[BSONValue]

Inherited by implicit conversion valueProducer fromBSONObjectID to Producer[BSONValue]

Inherited by implicit conversion any2stringadd fromBSONObjectID to any2stringadd[BSONObjectID]

Inherited by implicit conversion StringFormat fromBSONObjectID to StringFormat[BSONObjectID]

Inherited by implicit conversion Ensuring fromBSONObjectID to Ensuring[BSONObjectID]

Inherited by implicit conversion ArrowAssoc fromBSONObjectID to ArrowAssoc[BSONObjectID]

Ungrouped