Class: BSON::MinKey

Inherits:

Object

• Object
• BSON::MinKey

Includes:

JSON, Specialized, Comparable

Defined in:

lib/bson/min_key.rb

Overview

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

See Also:

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

Since:

• 2.0.0

Constant Summary

BSON_TYPE =

A $minKey is type 0xFF in the BSON spec.

Since:

• 2.0.0

255.chr.force_encoding(BINARY).freeze

LESSER =

Constant for always evaluating lesser in a comparison.

Since:

• 2.0.0

-1.freeze

Instance Method Summary

• #<=>(other) ⇒ Integer

  When comparing a min key with any other object, the min key will always be lesser.

• #as_json(*args) ⇒ Hash

  Get the min key as JSON hash data.

Methods included from Specialized

#==, #to_bson

Methods included from JSON

#to_json

Instance Method Details

#<=>(other) ⇒ Integer

When comparing a min key with any other object, the min key will always be lesser.

Examples:

Compare with another object.

min_key <=> 1000

Parameters:

• The (Object) —

  object to compare against.

Returns:

• (Integer) —

  Always -1.

Since:

• 2.0.0

# File 'lib/bson/min_key.rb', line 49

def <=>(other)
  LESSER
end

#as_json(*args) ⇒ Hash

Get the min key as JSON hash data.

Examples:

Get the min key as a JSON hash.

min_key.as_json

Returns:

• (Hash) —

  The min key as a JSON hash.

Since:

• 2.0.0

# File 'lib/bson/min_key.rb', line 61

def as_json(*args)
  { "$minKey" => 1 }
end