Parent

Included Modules

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

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(bson) click to toggle source

Deserialize timestamp from BSON.

@param [ BSON ] bson The bson representing a timestamp.

@return [ Timestamp ] The decoded timestamp.

@see bsonspec.org/#/specification

@since 2.0.0

# File lib/bson/timestamp.rb, line 104
def self.from_bson(bson)
  new(*bson.read(8).unpack(Int32::PACK * 2).reverse)
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 76
def initialize(seconds, increment)
  @seconds, @increment = seconds, increment
end

Public Instance Methods

==(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 50
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 63
def as_json(*args)
  { "t" => seconds, "i" => increment }
end
to_bson(encoded = ''.force_encoding(BINARY)) click to toggle source

Get the timestamp as its encoded raw BSON bytes.

@example Get the timestamp as BSON.

timestamp.to_bson

@return [ String ] The raw BSON bytes.

@see bsonspec.org/#/specification

@since 2.0.0

# File lib/bson/timestamp.rb, line 90
def to_bson(encoded = ''.force_encoding(BINARY))
  increment.to_bson_int32(encoded)
  seconds.to_bson_int32(encoded)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.