File: open_struct.rb

package info (click to toggle)
ruby-bson 5.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,828 kB
  • sloc: ruby: 11,712; ansic: 1,427; java: 514; makefile: 8
file content (59 lines) | stat: -rw-r--r-- 1,663 bytes parent folder | download
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
# frozen_string_literal: true
# rubocop:todo all
# Copyright (C) 2016-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

  # Injects behaviour for encoding OpenStruct objects using hashes
  # to raw bytes as specified by the BSON spec.
  #
  # @see http://bsonspec.org/#/specification
  #
  # @since 4.2.0
  module OpenStruct

    # Get the OpenStruct as encoded BSON.
    #
    # @example Get the OpenStruct object as encoded BSON.
    #   OpenStruct.new({ "field" => "value" }).to_bson
    #
    # @return [ BSON::ByteBuffer ] The buffer with the encoded object.
    #
    # @see http://bsonspec.org/#/specification
    #
    # @since 4.2.0
    def to_bson(buffer = ByteBuffer.new)
      if Environment.ruby_1_9?
        marshal_dump.dup
      else
        to_h
      end.to_bson(buffer)
    end

    # The BSON type for OpenStruct objects is the Hash type of 0x03.
    #
    # @example Get the bson type.
    #   struct.bson_type
    #
    # @return [ String ] The character 0x03.
    #
    # @since 4.2.0
    def bson_type
      ::Hash::BSON_TYPE
    end
  end

  ::OpenStruct.send(:include, OpenStruct) if defined?(::OpenStruct)
end