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 WriteConcern

    # An acknowledged write concern provides a get last error command with the
    # appropriate options on each write operation.
    #
    # @since 2.0.0
    class Acknowledged < Base
      # Get the get last error command for the concern.
      #
      # @example Get the gle command.
      #   acknowledged.get_last_error
      #
      # @return [ Hash ] The gle command.
      #
      # @since 2.0.0
      def get_last_error
        @get_last_error ||= { GET_LAST_ERROR => 1 }.merge(
          Options::Mapper.transform_values_to_strings(options)
        )
      end

      # Is this write concern acknowledged.
      #
      # @example Whether this write concern object is acknowledged.
      #   write_concern.acknowledged?
      #
      # @return [ true, false ] Whether this write concern is acknowledged.
      #
      # @since 2.5.0
      def acknowledged?
        true
      end

      # Get a human-readable string representation of an acknowledged write concern.
      #
      # @example Inspect the write concern.
      #   write_concern.inspect
      #
      # @return [ String ] A string representation of an acknowledged write concern.
      #
      # @since 2.0.0
      def inspect
        "#<Mongo::WriteConcern::Acknowledged:0x#{object_id} options=#{options}>"
      end
    end
  end
end