class BSON::Int32
Represents int32 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
- BYTES_LENGTH
The number of bytes constant.
@since 4.0.0
- PACK
Constant for the int 32 pack directive.
@since 2.0.0
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/int32.rb, line 48 def self.from_bson(buffer) buffer.get_int32 end
@param [ Integer ] integer The 32-bit integer.
@see bsonspec.org/#/specification
@since 4.2.0
# File lib/bson/int32.rb, line 59 def initialize(integer) out_of_range! unless integer.bson_int32? @integer = integer.freeze end
Public Instance Methods
Check equality of the int32 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/int32.rb, line 99 def ==(other) return false unless other.is_a?(Int32) @integer == other.instance_variable_get('@integer') end
Append the integer as encoded BSON to a ByteBuffer.
@example Encoded the integer and append to a ByteBuffer.
int32.to_bson
@return [ BSON::ByteBuffer ] The buffer with the encoded integer.
@see bsonspec.org/#/specification
@since 4.2.0
# File lib/bson/int32.rb, line 74 def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?) buffer.put_int32(@integer) 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/int32.rb, line 88 def to_bson_key(validating_keys = Config.validating_keys?) @integer end
Private Instance Methods
# File lib/bson/int32.rb, line 108 def out_of_range! raise RangeError.new("#{self} is not a valid 4 byte integer value.") end