struct

BSON::ObjectId

Inherits Comparable < Struct < Value < Object

Unique object identifier.

See: dochub.mongodb.org/core/objectids

Constructors

new(str : String)

Initialize from a hex string representation.

Source
new(data : Bytes)

Initialize from a Byte array.

Source
new(pull : JSON::PullParser)

Initialize from a JSON object.

Source
new

Create a random ObjectId.

Source

Class methods

reset_process_unique!

Rebuild the process-unique bytes and the counter. Called after fork.

Source
validate(id : String) : Bool

Validate that a provided string is a well formated ObjectId.

Source

Instance methods

<=>(other : ObjectId)

The comparison operator. Returns 0 if the two objects are equal, a negative number if this object is considered less than other, a positive number if this object is considered greater than other, or nil if the two objects are not comparable.

Subclasses define this method to provide class-specific ordering.

The comparison operator is usually used to sort values:

# Sort in a descending way:
[3, 1, 2].sort { |x, y| y <=> x } # => [3, 2, 1]

# Sort in an ascending way:
[3, 1, 2].sort { |x, y| x <=> y } # => [1, 2, 3]
Source
data

Copy of the 12 ObjectId bytes. Safe to keep after this value is gone.

Source
generation_time

Timestamp field as a UTC Time.

Source
timestamp

Seconds since the Unix epoch, as an unsigned 32-bit value.

Source
to_canonical_extjson(builder : JSON::Builder)

Serialize to a canonical extended json representation.

NOTE: see https://github.com/mongodb/specifications/blob/master/source/extended-json.rst

Source
to_json(builder : JSON::Builder)
Source
to_s(io : IO) : Nil

Return a string hex representation of the ObjectId.

Source
to_slice

Inline 12-byte view. Valid only while this ObjectId value is alive.

Source

Nested types