class BSON::Int32

Represents a $maxKey type, which compares less than any other value in the specification.

@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

from_bson(buffer) click to toggle source

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 49
def self.from_bson(buffer)
  buffer.get_int32
end
new(integer) click to toggle source

Instantiate a BSON Int32.

@param [ Integer ] integer The 32-bit integer.

@see bsonspec.org/#/specification

@since 4.2.0

# File lib/bson/int32.rb, line 60
def initialize(integer)
  out_of_range! unless integer.bson_int32?
  @integer = integer.freeze
end

Public Instance Methods

to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?) click to toggle source

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 75
def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
  buffer.put_int32(@integer)
end
to_bson_key(validating_keys = Config.validating_keys?) click to toggle source

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 89
def to_bson_key(validating_keys = Config.validating_keys?)
  @integer.to_bson_key(validating_keys)
end

Private Instance Methods

out_of_range!() click to toggle source
# File lib/bson/int32.rb, line 95
def out_of_range!
  raise RangeError.new("#{self} is not a valid 4 byte integer value.")
end