struct BSON::ObjectId
- BSON::ObjectId
- Struct
- Value
- Object
Overview
Unique object identifier.
See: dochub.mongodb.org/core/objectids
Included Modules
- Comparable(BSON::ObjectId)
Defined in:
Constructors
-
.new(str : String)
Initialize from a hex string representation.
-
.new(data : Bytes)
Initialize from a Byte array.
-
.new(pull : JSON::PullParser)
Initialize from a JSON object.
-
.new
Create a random ObjectId.
Instance Method Summary
-
#<=>(other : ObjectId)
The comparison operator.
- #data : Bytes
-
#to_canonical_extjson(builder : JSON::Builder)
Serialize to a canonical extended json representation.
- #to_json(builder : JSON::Builder)
-
#to_s(io : IO) : Nil
Return a string hex representation of the ObjectId.
Constructor Detail
Instance Method Detail
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 greter 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]
Serialize to a canonical extended json representation.
NOTE see https://github.com/mongodb/specifications/blob/master/source/extended-json.rst