module BSON::FalseClass

Injects behaviour for encoding and decoding false values to and from raw bytes as specified by the BSON spec.

@see bsonspec.org/#/specification

@since 2.0.0

Constants

FALSE_BYTE

A false value in the BSON spec is 0x00.

@since 2.0.0

Public Instance Methods

bson_type ()

Source

# File lib/bson/false_class.rb, line 39
def bson_type
  Boolean::BSON_TYPE
end

The BSON type for false values is the general boolean type of 0x08.

@example Get the bson type.

false.bson_type

@return [ String ] The character 0x08.

@since 2.0.0

to_bson (buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)

Source

# File lib/bson/false_class.rb, line 53
def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
  buffer.put_byte(FALSE_BYTE)
end

Get the false boolean as encoded BSON.

@example Get the false boolean as encoded BSON.

false.to_bson

@return [ BSON::ByteBuffer ] The buffer with the encoded object.

@see bsonspec.org/#/specification

@since 2.0.0