1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
# frozen_string_literal: true
# rubocop:todo all
# Copyright (C) 2009-2020 MongoDB Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
module BSON
# Represents int32 type.
#
# @see http://bsonspec.org/#/specification
#
# @since 2.0.0
class Int32
include JSON
# A boolean is type 0x08 in the BSON spec.
#
# @since 2.0.0
BSON_TYPE = ::String.new(16.chr, encoding: BINARY).freeze
# The number of bytes constant.
#
# @since 4.0.0
BYTES_LENGTH = 4
# Constant for the int 32 pack directive.
#
# @since 2.0.0
PACK = "l<"
# 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 http://bsonspec.org/#/specification
#
# @since 2.0.0
def self.from_bson(buffer, **options)
buffer.get_int32
end
# Instantiate a BSON Int32.
#
# @param [ Integer ] value The 32-bit integer.
#
# @see http://bsonspec.org/#/specification
#
# @since 4.2.0
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
# Returns the value of this Int32.
#
# @return [ Integer ] The integer value.
attr_reader :value
# 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 http://bsonspec.org/#/specification
#
# @since 4.2.0
def to_bson(buffer = ByteBuffer.new)
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
#
# @return [ String ] The string key.
#
# @since 4.2.0
def to_bson_key
value
end
# 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
def ==(other)
return false unless other.is_a?(Int32)
value == other.value
end
alias :eql? :==
alias :=== :==
# Return a string representation of the Int32 for use in
# application-level JSON serialization. This method is intentionally
# different from #as_extended_json.
#
# @example Get the Int32 as a JSON-serializable object.
# int32.as_json
#
# @return [ Integer ] The Int32 as an Integer.
def as_json(**options)
value
end
# Converts this object to a representation directly serializable to
# Extended JSON (https://github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).
#
# 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.
def as_extended_json(**options)
if options[:mode] == :relaxed || options[:mode] == :legacy
value
else
{'$numberInt' => value.to_s}
end
end
# Register this type when the module is loaded.
#
# @since 2.0.0
Registry.register(BSON_TYPE, self)
end
end
|
