Class: BSON::Int32

Inherits:
Object
  • Object
show all
Defined in:
lib/bson/int32.rb

Overview

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

See Also:

Since:

  • 2.0.0

Constant Summary collapse

BSON_TYPE =

A boolean is type 0x08 in the BSON spec.

Since:

  • 2.0.0

16.chr.force_encoding(BINARY).freeze
BYTES_LENGTH =

The number of bytes constant.

Since:

  • 4.0.0

4
PACK =

Constant for the int 32 pack directive.

Since:

  • 2.0.0

"l<".freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(integer) ⇒ Int32

Instantiate a BSON Int32.

Parameters:

  • integer (Integer) —

    The 32-bit integer.

See Also:

Since:

  • 4.2.0


60
61
62
63
 
# File 'lib/bson/int32.rb', line 60

def initialize(integer)
  out_of_range! unless integer.bson_int32?
  @integer = integer.freeze
end

Class Method Details

.from_bson(buffer) ⇒ Integer

Deserialize an Integer from BSON.

Parameters:

  • buffer (ByteBuffer) —

    The byte buffer.

Returns:

  • (Integer) —

    The decoded Integer.

See Also:

Since:

  • 2.0.0


49
50
51
 
# File 'lib/bson/int32.rb', line 49

def self.from_bson(buffer)
  buffer.get_int32
end

Instance Method Details

#to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?) ⇒ BSON::ByteBuffer

Append the integer as encoded BSON to a ByteBuffer.

Examples:

Encoded the integer and append to a ByteBuffer.

int32.to_bson

Returns:

  • (BSON::ByteBuffer) —

    The buffer with the encoded integer.

See Also:

Since:

  • 4.2.0


75
76
77
 
# 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?) ⇒ String

Convert the integer to a BSON string key.

Examples:

Convert the integer to a BSON key string.

int.to_bson_key

Parameters:

  • validating_keys (true, false) (defaults to: Config.validating_keys?) —

    If BSON should validate the key.

Returns:

  • (String) —

    The string key.

Since:

  • 4.2.0


89
90
91
 
# File 'lib/bson/int32.rb', line 89

def to_bson_key(validating_keys = Config.validating_keys?)
  @integer.to_bson_key(validating_keys)
end