const classafBson::ObjectId

sys::Obj
  afBson::ObjectId

@Serializable { simple=true }

(BSON Type) - A globally unique identifier for MongoDB objects.

Consists of 12 bytes, divided as follows:

| 0  1  2  3 | 4  5  6 | 7  8 | 9 10 11
| timestamp  | machine | pid  | inc

@See

fromStr

Source

static new fromStr(Str hex, Bool checked := true)

Create an ObjectId from a hex string.

fromStream

Source

static new fromStream(InStream in)

Reads an ObjectId from the given stream.

Note the stream is not closed.

inc

Source

const Int inc

A 3-byte inc value.

machine

Source

const Int machine

A 4-byte machine identifier, usually the IP address.

make

Source

new make()

Creates a new ObjectId.

pid

Source

const Int pid

A 2-byte process id that this instance was created under.

timestamp

Source

const DateTime timestamp

The creation timestamp with a 1 second accuracy.

toBuf

Source

Buf toBuf()

Encodes this ObjectId into an 12 byte buffer. The returned buffer is positioned at the start and is ready to read.

toHex

Source

Str toHex()

Converts this instance into a 24 character hexadecimal string representation.

toJs

Source

Str toJs()

Returns a Mongo Shell compliant, JavaScript representation of the ObjectId. Example:

objectId.toJs  // --> ObjectId("57fe499fa81320d933000001")

See MongoDB Extended JSON.

toStr

Source

virtual override Str toStr()

Returns this ObjectId as a 24 character hexadecimal string.