class BSON::ObjectId
Represents object_id data.
@see bsonspec.org/#/specification
@since 2.0.0
Constants
- BSON_TYPE
A object_id is type 0x07 in the BSON spec.
@since 2.0.0
Private Class Methods
Deserialize the object id from raw BSON bytes.
@example Get the object id from BSON.
ObjectId.from_bson(bson)
@param [ ByteBuffer ] buffer The byte buffer.
@return [ BSON::ObjectId ] The object id.
@since 2.0.0
# File lib/bson/object_id.rb, line 223 def from_bson(buffer) from_data(buffer.get_bytes(12)) end
Create a new object id from raw bytes.
@example Create an object id from raw bytes.
BSON::ObjectId.from_data(data)
@param [ String ] data The raw bytes.
@return [ ObjectId ] The new object id.
@since 2.0.0
# File lib/bson/object_id.rb, line 237 def from_data(data) object_id = allocate object_id.instance_variable_set(:@raw_data, data) object_id end
Create a new object id from a string.
@example Create an object id from the string.
BSON::ObjectId.from_string(id)
@param [ String ] string The string to create the id from.
@raise [ BSON::ObjectId::Invalid ] If the provided string is invalid.
@return [ BSON::ObjectId ] The new object id.
@since 2.0.0
# File lib/bson/object_id.rb, line 255 def from_string(string) unless legal?(string) raise Invalid.new("'#{string}' is an invalid ObjectId.") end from_data([ string ].pack("H*")) end
Create a new object id from a time.
@example Create an object id from a time.
BSON::ObjectId.from_time(time)
@example Create an object id from a time, ensuring uniqueness.
BSON::ObjectId.from_time(time, unique: true)
@param [ Time ] time The time to generate from. @param [ Hash ] options The options.
@option options [ true, false ] :unique Whether the id should be
unique.
@return [ ObjectId ] The new object id.
@since 2.0.0
# File lib/bson/object_id.rb, line 279 def from_time(time, options = {}) from_data(options[:unique] ? @@generator.next_object_id(time.to_i) : [ time.to_i ].pack("Nx8")) end
Determine if the provided string is a legal object id.
@example Is the string a legal object id?
BSON::ObjectId.legal?(string)
@param [ String ] string The string to check.
@return [ true, false ] If the string is legal.
@since 2.0.0
# File lib/bson/object_id.rb, line 293 def legal?(string) string.to_s =~ /\A[0-9a-f]{24}\z/i ? true : false end
Executes the provided block only if the size of the provided object is
-
Used in legacy id repairs.
@example Execute in a repairing block.
BSON::ObjectId.repair("test") { obj }
@param [ String, Array ] object The object to repair.
@raise [ Invalid ] If the array is not 12 elements.
@return [ String ] The result of the block.
@since 2.0.0
# File lib/bson/object_id.rb, line 310 def repair(object) if object.size == 12 block_given? ? yield(object) : object else raise Invalid.new("#{object.inspect} is not a valid object id.") end end
Public Instance Methods
Compare this object id with another object for use in sorting.
@example Compare the object id with the other object.
object <=> other
@param [ Object ] other The object to compare to.
@return [ Integer ] The result of the comparison.
@since 2.0.0
# File lib/bson/object_id.rb, line 88 def <=>(other) generate_data <=> other.to_bson.to_s end
Check equality of the object id with another object.
@example Check if the object id is equal to the other.
object_id == other
@param [ Object ] other The object to check against.
@return [ true, false ] If the objects are equal.
@since 2.0.0
# File lib/bson/object_id.rb, line 45 def ==(other) return false unless other.is_a?(ObjectId) generate_data == other.send(:generate_data) end
Check case equality on the object id.
@example Check case equality.
object_id === other
@param [ Object ] other The object to check against.
@return [ true, false ] If the objects are equal in a case.
@since 2.0.0
# File lib/bson/object_id.rb, line 61 def ===(other) return to_str === other.to_str if other.respond_to?(:to_str) super end
Return the UTC time at which this ObjectId was generated. This may be used instread of a created_at timestamp since this information is always encoded in the object id.
@example Get the generation time.
object_id.generation_time
@return [ Time ] The time the id was generated.
@since 2.0.0
# File lib/bson/object_id.rb, line 102 def generation_time ::Time.at(generate_data.unpack("N")[0]).utc end
Get the hash value for the object id.
@example Get the hash value.
object_id.hash
@return [ Integer ] The hash value.
@since 2.0.0
# File lib/bson/object_id.rb, line 115 def hash generate_data.hash end
Get a nice string for use with object inspection.
@example Inspect the object id.
object_id.inspect
@return [ String ] The object id in form BSON::ObjectId('id')
@since 2.0.0
# File lib/bson/object_id.rb, line 127 def inspect "BSON::ObjectId('#{to_s}')" end
Dump the raw bson when calling Marshal.dump.
@example Dump the raw bson.
Marshal.dump(object_id)
@return [ String ] The raw bson bytes.
@since 2.0.0
# File lib/bson/object_id.rb, line 139 def marshal_dump generate_data end
Get the object id as it's raw BSON data.
@example Get the raw bson bytes.
object_id.to_bson
@note Since Moped's BSON and MongoDB BSON before 2.0.0 have different
internal representations, we will attempt to repair the data for cases where the object was instantiated in a non-standard way. (Like a Marshal.load)
@return [ BSON::ByteBuffer ] The buffer with the encoded object.
@see bsonspec.org/#/specification
@since 2.0.0
# File lib/bson/object_id.rb, line 172 def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?) buffer.put_bytes(generate_data) end
Get the string representation of the object id.
@example Get the object id as a string.
object_id.to_s
@return [ String ] The object id as a string.
@since 2.0.0
# File lib/bson/object_id.rb, line 184 def to_s generate_data.to_hex_string.force_encoding(UTF8) end
Private Instance Methods
# File lib/bson/object_id.rb, line 201 def generate_data repair if defined?(@data) @raw_data ||= @@generator.next_object_id end
# File lib/bson/object_id.rb, line 196 def initialize_copy(other) generate_data other.instance_variable_set(:@raw_data, @raw_data) end
# File lib/bson/object_id.rb, line 206 def repair @raw_data = @data.to_bson_object_id remove_instance_variable(:@data) end