Module: BSON::TrueClass

Defined in:

lib/bson/true_class.rb

Overview

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

See Also:

• http://bsonspec.org/#/specification

Since:

• 2.0.0

Constant Summary

TRUE_BYTE =

A true value in the BSON spec is 0x01.

Since:

• 2.0.0

::String.new(1.chr, encoding: BINARY).freeze

Instance Method Summary

• #bson_type ⇒ String

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

• #to_bson(buffer = ByteBuffer.new) ⇒ BSON::ByteBuffer

  Get the true boolean as encoded BSON.

Instance Method Details

#bson_type ⇒ String

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

Examples:

Get the bson type.

false.bson_type

Returns:

• (String) —

  The character 0x08.

Since:

• 2.0.0

# File 'lib/bson/true_class.rb', line 40

def bson_type
  Boolean::BSON_TYPE
end

#to_bson(buffer = ByteBuffer.new) ⇒ BSON::ByteBuffer

Get the true boolean as encoded BSON.

Examples:

Get the true boolean as encoded BSON.

true.to_bson

Returns:

• (BSON::ByteBuffer) —

  The buffer with the encoded object.

See Also:

• http://bsonspec.org/#/specification

Since:

• 2.0.0

# File 'lib/bson/true_class.rb', line 54

def to_bson(buffer = ByteBuffer.new)
  buffer.put_byte(TRUE_BYTE)
end