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
Attributes
Public Class Methods
Deserialize an Integer
from BSON
.
@param [ ByteBuffer
] buffer The byte buffer.
@option options [ nil | :bson ] :mode Decoding mode to use.
@return [ Integer
] The decoded Integer
.
@see bsonspec.org/#/specification
@since 2.0.0
# File lib/bson/int32.rb, line 51 def self.from_bson(buffer, **options) buffer.get_int32 end
@param [ Integer
] value The 32-bit integer.
@see bsonspec.org/#/specification
@since 4.2.0
# File lib/bson/int32.rb, line 62 def initialize(value) if value.is_a?(self.class) @value = value.value return end unless value.bson_int32? raise RangeError.new("#{value} cannot be stored in 32 bits") end @value = value.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 114 def ==(other) return false unless other.is_a?(Int32) value == other.value end
Converts this object to a representation directly serializable to Extended JSON
(github.com/mongodb/specifications/blob/master/source/extended-json.rst).
This method returns the integer value if relaxed representation is requested, otherwise a $numberInt hash.
@option opts [ nil | :relaxed | :legacy ] :mode Serialization mode
(default is canonical extended JSON)
@return [ Hash
| Integer
] The extended json representation.
# File lib/bson/int32.rb, line 131 def as_extended_json(**options) if options[:mode] == :relaxed || options[:mode] == :legacy value else {'$numberInt' => value.to_s} end 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 89 def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?) buffer.put_int32(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/int32.rb, line 103 def to_bson_key(validating_keys = Config.validating_keys?) value end