Class: BSON::Int32
- Inherits:
-
Object
- Object
- BSON::Int32
- Defined in:
- lib/bson/int32.rb
Overview
Represents int32 type.
Constant Summary collapse
- BSON_TYPE =
A boolean is type 0x08 in the BSON spec.
16.chr.force_encoding(BINARY).freeze
- BYTES_LENGTH =
The number of bytes constant.
4
- PACK =
Constant for the int 32 pack directive.
"l<".freeze
Instance Attribute Summary collapse
-
#value ⇒ Integer
readonly
Returns the value of this Int32.
Class Method Summary collapse
-
.from_bson(buffer, **options) ⇒ Integer
Deserialize an Integer from BSON.
Instance Method Summary collapse
-
#==(other) ⇒ true, false
(also: #eql?, #===)
Check equality of the int32 with another object.
-
#as_extended_json(**options) ⇒ Hash | Integer
Converts this object to a representation directly serializable to Extended JSON (github.com/mongodb/specifications/blob/master/source/extended-json.rst).
-
#initialize(value) ⇒ Int32
constructor
Instantiate a BSON Int32.
-
#to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?) ⇒ BSON::ByteBuffer
Append the integer as encoded BSON to a ByteBuffer.
-
#to_bson_key(validating_keys = Config.validating_keys?) ⇒ String
Convert the integer to a BSON string key.
Constructor Details
#initialize(value) ⇒ Int32
Instantiate a BSON Int32.
61 62 63 64 65 66 67 68 69 70 71 |
# File 'lib/bson/int32.rb', line 61 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 |
Instance Attribute Details
#value ⇒ Integer (readonly)
Returns the value of this Int32.
76 77 78 |
# File 'lib/bson/int32.rb', line 76 def value @value end |
Class Method Details
.from_bson(buffer, **options) ⇒ Integer
Deserialize an Integer from BSON.
50 51 52 |
# File 'lib/bson/int32.rb', line 50 def self.from_bson(buffer, **) buffer.get_int32 end |
Instance Method Details
#==(other) ⇒ true, false Also known as: eql?, ===
Check equality of the int32 with another object.
113 114 115 116 |
# File 'lib/bson/int32.rb', line 113 def ==(other) return false unless other.is_a?(Int32) value == other.value end |
#as_extended_json(**options) ⇒ Hash | Integer
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.
130 131 132 133 134 135 136 |
# File 'lib/bson/int32.rb', line 130 def as_extended_json(**) if [:mode] == :relaxed || [:mode] == :legacy value else {'$numberInt' => value.to_s} end end |
#to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?) ⇒ BSON::ByteBuffer
Append the integer as encoded BSON to a ByteBuffer.
88 89 90 |
# File 'lib/bson/int32.rb', line 88 def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?) buffer.put_int32(value) end |
#to_bson_key(validating_keys = Config.validating_keys?) ⇒ String
Convert the integer to a BSON string key.
102 103 104 |
# File 'lib/bson/int32.rb', line 102 def to_bson_key(validating_keys = Config.validating_keys?) value end |