Sha256: 3906c1c23eb89e9990f064a6b686102582c1d3f1c0a5775b81028e777f6bd87c

Contents?: true

Size: 1.93 KB

Versions: 18

Compression:

Stored size: 1.93 KB

Contents

# frozen_string_literal: true
# encoding: utf-8

# Copyright (C) 2015-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 Mongo
  module Operation
    class Find

      # Defines custom behavior of results in find command.
      #
      # @since 2.2.0
      # @api semiprivate
      class Result < Operation::Result

        # Get the cursor id.
        #
        # @example Get the cursor id.
        #   result.cursor_id
        #
        # @return [ Integer ] The cursor id.
        #
        # @since 2.2.0
        # @api private
        def cursor_id
          cursor_document ? cursor_document[CURSOR_ID] : super
        end

        # Get the documents in the result.
        #
        # @example Get the documents.
        #   result.documents
        #
        # @return [ Array<BSON::Document> ] The documents.
        #
        # @since 2.2.0
        # @api public
        def documents
          cursor_document[FIRST_BATCH]
        end

        # The namespace in which this find command was performed.
        #
        # @return [ String ] The namespace, usually in the format
        #   "database.collection".
        #
        # @api private
        def namespace
          cursor_document['ns']
        end

        private

        def cursor_document
          @cursor_document ||= reply.documents[0][CURSOR]
        end

        def first_document
          @first_document ||= reply.documents[0]
        end
      end
    end
  end
end

Version data entries

18 entries across 18 versions & 1 rubygems

Version Path
mongo-2.16.4 lib/mongo/operation/find/result.rb
mongo-2.17.4 lib/mongo/operation/find/result.rb
mongo-2.18.3 lib/mongo/operation/find/result.rb
mongo-2.18.2 lib/mongo/operation/find/result.rb
mongo-2.17.3 lib/mongo/operation/find/result.rb
mongo-2.18.1 lib/mongo/operation/find/result.rb
mongo-2.18.0 lib/mongo/operation/find/result.rb
mongo-2.17.2 lib/mongo/operation/find/result.rb
mongo-2.16.3 lib/mongo/operation/find/result.rb
mongo-2.18.0.beta1 lib/mongo/operation/find/result.rb
mongo-2.16.2 lib/mongo/operation/find/result.rb
mongo-2.17.1 lib/mongo/operation/find/result.rb
mongo-2.16.1 lib/mongo/operation/find/result.rb
mongo-2.17.0 lib/mongo/operation/find/result.rb
mongo-2.16.0 lib/mongo/operation/find/result.rb
mongo-2.15.1 lib/mongo/operation/find/result.rb
mongo-2.16.0.alpha1 lib/mongo/operation/find/result.rb
mongo-2.15.0 lib/mongo/operation/find/result.rb