Module: BSON::Float

Defined in:
lib/bson/float.rb

Overview

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

See Also:

Since:

  • 2.0.0

Defined Under Namespace

Modules: ClassMethods

Constant Summary collapse

BSON_TYPE =

A floating point is type 0x01 in the BSON spec.

Since:

  • 2.0.0

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

The pack directive is for 8 byte floating points.

Since:

  • 2.0.0

"E"

Instance Method Summary collapse

Instance Method Details

#as_extended_json(**options) ⇒ Hash | Float

Converts this object to a representation directly serializable to Extended JSON (github.com/mongodb/specifications/blob/master/source/extended-json/extended-json.md).

This method returns the float itself if relaxed representation is requested and the value is finite, otherwise a $numberDouble hash.

Parameters:

  • opts (Hash) —

    a customizable set of options

Returns:

  • (Hash | Float) —

    The extended json representation.

Since:

  • 2.0.0



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/bson/float.rb', line 61

def as_extended_json(**options)
  if infinite? == 1
    { '$numberDouble' => 'Infinity' }
  elsif infinite? == -1
    { '$numberDouble' => '-Infinity' }
  elsif nan?
    { '$numberDouble' => 'NaN' }
  elsif options[:mode] == :relaxed || options[:mode] == :legacy
    self
  elsif BSON::Environment.jruby? && abs > 1e15
    # Hack to make bson corpus spec tests pass.
    # JRuby serializes -1.2345678901234568e+18 as
    # -1234567890123456770.0, which is valid but differs from MRI
    # serialization. Extended JSON spec does not define precise
    # stringification of floats.
    # https://jira.mongodb.org/browse/SPEC-1536
    { '$numberDouble' => ('%.17g' % to_s).upcase }
  else
    { '$numberDouble' => to_s.upcase }
  end
end

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

Get the floating point as encoded BSON.

Examples:

Get the floating point as encoded BSON.

1.221311.to_bson

Returns:

See Also:

Since:

  • 2.0.0



47
48
49
 
# File 'lib/bson/float.rb', line 47

def to_bson(buffer = ByteBuffer.new)
  buffer.put_double(self)
end