1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
|
# frozen_string_literal: true
# rubocop:todo all
# Copyright (C) 2009-2020 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
# Provides behaviour to special values that exist in the BSON spec that don't
# have a native type, like $minKey and $maxKey.
#
# @see http://bsonspec.org/#/specification
#
# @since 2.0.0
module Specialized
# Determine if the min key is equal to another object.
#
# @example Check min key equality.
# BSON::MinKey.new == object
#
# @param [ Object ] other The object to check against.
#
# @return [ true, false ] If the objects are equal.
#
# @since 2.0.0
def ==(other)
self.class == other.class
end
# Encode the min key - has no value since it only needs the type and field
# name when being encoded.
#
# @example Encode the min key value.
# min_key.to_bson
#
# @return [ BSON::ByteBuffer ] The buffer with the encoded object.
#
# @since 2.0.0
def to_bson(buffer = ByteBuffer.new)
buffer
end
private
def self.included(klass)
klass.extend(ClassMethods)
end
module ClassMethods
# Deserialize from BSON.
#
# @param [ ByteBuffer ] buffer The byte buffer.
#
# @option options [ nil | :bson ] :mode Decoding mode to use.
#
# @return [ Specialized ] The decoded specialized class.
#
# @see http://bsonspec.org/#/specification
#
# @since 2.0.0
def from_bson(buffer, **options)
new
end
end
end
end
|