module BSON::TrueClass

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

@see bsonspec.org/#/specification

@since 2.0.0

Constants

TRUE_BYTE

A true value in the BSON spec is 0x01.

@since 2.0.0

Public Instance Methods

bson_type() click to toggle source

The BSON type for true 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

# File lib/bson/true_class.rb, line 39
def bson_type
  Boolean::BSON_TYPE
end
to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?) click to toggle source

Get the true boolean as encoded BSON.

@example Get the true boolean as encoded BSON.

true.to_bson

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

@see bsonspec.org/#/specification

@since 2.0.0

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