Sha256: 4ad5613d36e1a5668cfdc3dbedaa4a0f344b323cd63b5e67ff65130ce35a350e
Contents?: true
Size: 1.76 KB
Versions: 54
Compression:
Stored size: 1.76 KB
Contents
# Copyright (C) 2009-2014 MongoDB Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
module BSON
# Represents a $minKey type, which compares less than any other value in the
# specification.
#
# @see http://bsonspec.org/#/specification
#
# @since 2.0.0
class MinKey
include Comparable
include JSON
include Specialized
# A $minKey is type 0xFF in the BSON spec.
#
# @since 2.0.0
BSON_TYPE = 255.chr.force_encoding(BINARY).freeze
# Constant for always evaluating lesser in a comparison.
#
# @since 2.0.0
LESSER = -1.freeze
# When comparing a min key with any other object, the min key will always
# be lesser.
#
# @example Compare with another object.
# min_key <=> 1000
#
# @param [ Object ] The object to compare against.
#
# @return [ Integer ] Always -1.
#
# @since 2.0.0
def <=>(other)
LESSER
end
# Get the min key as JSON hash data.
#
# @example Get the min key as a JSON hash.
# min_key.as_json
#
# @return [ Hash ] The min key as a JSON hash.
#
# @since 2.0.0
def as_json(*args)
{ "$minKey" => 1 }
end
# Register this type when the module is loaded.
#
# @since 2.0.0
Registry.register(BSON_TYPE, self)
end
end
Version data entries
54 entries across 52 versions & 3 rubygems