mongodb/mongo-ruby-driver

# frozen_string_literal: true
# rubocop:todo all

# Copyright (C) 2014-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 Insert

      # Defines custom behavior of results for an insert.
      #
      # According to the CRUD spec, reporting the inserted ids
      # is optional. It can be added to this class later, if needed.
      #
      # @since 2.0.0
      # @api semiprivate
      class Result < Operation::Result

        # Get the ids of the inserted documents.
        #
        # @since 2.0.0
        # @api public
        attr_reader :inserted_ids

        # Initialize a new result.
        #
        # @example Instantiate the result.
        #   Result.new(replies, inserted_ids)
        #
        # @param [ Array<Protocol::Message> | nil ] replies The wire protocol replies, if any.
        # @param [ Server::Description ] connection_description
        #   Server description of the server that performed the operation that
        #   this result is for.
        # @param [ Integer ] connection_global_id
        #   Global id of the connection on which the operation that
        #   this result is for was performed.
        # @param [ Array<Object> ] ids The ids of the inserted documents.
        #
        # @since 2.0.0
        # @api private
        def initialize(replies, connection_description, connection_global_id, ids)
          super(replies, connection_description, connection_global_id)
          @inserted_ids = ids
        end

        # Gets the id of the document inserted.
        #
        # @example Get id of the document inserted.
        #   result.inserted_id
        #
        # @return [ Object ] The id of the document inserted.
        #
        # @since 2.0.0
        # @api public
        def inserted_id
          inserted_ids.first
        end

        # @api public
        def bulk_result
          BulkResult.new(@replies, connection_description, connection_global_id, @inserted_ids)
        end
      end
    end
  end
end