class BSON::Timestamp

Represents a timestamp type, which is predominately used for sharding.

@see bsonspec.org/#/specification

@since 2.0.0

Constants

BSON_TYPE

A timestamp is type 0x11 in the BSON spec.

@since 2.0.0

COMPARISON_ERROR_MESSAGE

Error message if an object other than a Timestamp is compared with this object.

@since 4.3.0

Attributes

increment[R]

@!attribute seconds

@return [ Integer ] The number of seconds.
@since 2.0.0

@!attribute increment

@return [ Integer ] The incrementing value.
@since 2.0.0
seconds[R]

@!attribute seconds

@return [ Integer ] The number of seconds.
@since 2.0.0

@!attribute increment

@return [ Integer ] The incrementing value.
@since 2.0.0

Public Class Methods

from_bson(buffer) click to toggle source

Deserialize timestamp from BSON.

@param [ ByteBuffer ] buffer The byte buffer.

@return [ Timestamp ] The decoded timestamp.

@see bsonspec.org/#/specification

@since 2.0.0

# File lib/bson/timestamp.rb, line 128
def self.from_bson(buffer)
  increment = buffer.get_int32
  seconds = buffer.get_int32
  new(seconds, increment)
end
new(seconds, increment) click to toggle source

Instantiate the new timestamp.

@example Instantiate the timestamp.

BSON::Timestamp.new(5, 30)

@param [ Integer ] seconds The number of seconds. @param [ Integer ] increment The increment value.

@since 2.0.0

# File lib/bson/timestamp.rb, line 100
def initialize(seconds, increment)
  @seconds, @increment = seconds, increment
end

Public Instance Methods

<=>(other) click to toggle source

Determine if this timestamp is greater or less than another object.

@example Compare the timestamp.

timestamp < other

@param [ Object ] other The object to compare against.

@return [ true, false ] The result of the comparison.

@since 4.3.0

# File lib/bson/timestamp.rb, line 71
def <=>(other)
  raise ArgumentError.new(COMPARISON_ERROR_MESSAGE % other.class) unless other.is_a?(Timestamp)
  return 0 if self == other
  a = [ seconds, increment ]
  b = [ other.seconds, other.increment ]
  [ a, b ].sort[0] == a ? -1 : 1
end
==(other) click to toggle source

Determine if this timestamp is equal to another object.

@example Check the timestamp equality.

timestamp == other

@param [ Object ] other The object to compare against.

@return [ true, false ] If the objects are equal.

@since 2.0.0

# File lib/bson/timestamp.rb, line 56
def ==(other)
  return false unless other.is_a?(Timestamp)
  seconds == other.seconds && increment == other.increment
end
as_json(*args) click to toggle source

Get the timestamp as JSON hash data.

@example Get the timestamp as a JSON hash.

timestamp.as_json

@return [ Hash ] The timestamp as a JSON hash.

@since 2.0.0

# File lib/bson/timestamp.rb, line 87
def as_json(*args)
  { "$timestamp" => { "t" => seconds, "i" => increment } }
end
to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?) click to toggle source

Get the timestamp as its encoded raw BSON bytes.

@example Get the timestamp as BSON.

timestamp.to_bson

@return [ BSON::ByteBuffer ] The buffer with the encoded object.

@see bsonspec.org/#/specification

@since 2.0.0

# File lib/bson/timestamp.rb, line 114
def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
  buffer.put_int32(increment)
  buffer.put_int32(seconds)
end