struct BSON::ObjectId

Overview

Unique object identifier.

See: dochub.mongodb.org/core/objectids

Included Modules

Defined in:

bson/object_id.cr

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

def self.new(str : String) #

Initialize from a hex string representation.


[View source]
def self.new(data : Bytes) #

Initialize from a Byte array.


[View source]
def self.new(pull : JSON::PullParser) #

Initialize from a JSON object.


[View source]
def self.new #

Create a random ObjectId.


[View source]

Class Method Detail

def self.validate(id : String) : Bool #

Validate that a provided string is a well formated ObjectId.


[View source]

Instance Method Detail

def <=>(other : ObjectId) #
Description copied from module Comparable(BSON::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]

[View source]
def data : Bytes #

[View source]
def 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


[View source]
def to_json(builder : JSON::Builder) #

[View source]
def to_s(io : IO) : Nil #

Return a string hex representation of the ObjectId.


[View source]