class BSON::Int64
Represents int64 type.
@see bsonspec.org/#/specification
@since 2.0.0
Constants
- BSON_TYPE
A boolean is type 0x08 in the
BSON
spec.@since 2.0.0
- PACK
Constant for the int 64 pack directive.
@since 2.0.0
Attributes
Public Class Methods
Deserialize an Integer
from BSON
.
@param [ ByteBuffer
] buffer The byte buffer.
@return [ Integer
] The decoded Integer
.
@see bsonspec.org/#/specification
@since 2.0.0
# File lib/bson/int64.rb, line 43 def self.from_bson(buffer) buffer.get_int64 end
@param [ Integer
] value The 64-bit integer.
@see bsonspec.org/#/specification
@since 4.2.0
# File lib/bson/int64.rb, line 54 def initialize(value) if value.is_a?(self.class) @value = value.value return end unless value.bson_int64? raise RangeError.new("#{value} cannot be stored in 64 bits") end @value = value.freeze end
Public Instance Methods
Check equality of the int64 with another object.
@param [ Object
] other The object to check against.
@return [ true, false ] If the objects are equal.
@since 4.4.0
# File lib/bson/int64.rb, line 106 def ==(other) return false unless other.is_a?(Int64) value == other.value end
Append the integer as encoded BSON
to a ByteBuffer
.
@example Encoded the integer and append to a ByteBuffer
.
int64.to_bson
@return [ BSON::ByteBuffer
] The buffer with the encoded integer.
@see bsonspec.org/#/specification
@since 4.2.0
# File lib/bson/int64.rb, line 81 def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?) buffer.put_int64(value) end
Convert the integer to a BSON
string key.
@example Convert the integer to a BSON
key string.
int.to_bson_key
@param [ true, false ] validating_keys If BSON
should validate the key.
@return [ String
] The string key.
@since 4.2.0
# File lib/bson/int64.rb, line 95 def to_bson_key(validating_keys = Config.validating_keys?) value end