module LanguageServer
  module Protocol
    module Interface
      #
      # The result returned from the apply workspace edit request.
      #
      # @since 3.17 renamed from ApplyWorkspaceEditResponse
      #
      class ApplyWorkspaceEditResult
        def initialize(applied:, failure_reason: nil, failed_change: nil)
          @attributes = {}

          @attributes[:applied] = applied
          @attributes[:failureReason] = failure_reason if failure_reason
          @attributes[:failedChange] = failed_change if failed_change

          @attributes.freeze
        end

        #
        # Indicates whether the edit was applied or not.
        #
        # @return [boolean]
        def applied
          attributes.fetch(:applied)
        end

        #
        # An optional textual description for why the edit was not applied.
        # This may be used by the server for diagnostic logging or to provide
        # a suitable error for a request that triggered the edit.
        #
        # @return [string | nil]
        def failure_reason
          attributes.fetch(:failureReason)
        end

        #
        # Depending on the client's failure handling strategy `failedChange` might
        # contain the index of the change that failed. This property is only available
        # if the client signals a `failureHandlingStrategy` in its client capabilities.
        #
        # @return [uinteger | nil]
        def failed_change
          attributes.fetch(:failedChange)
        end

        attr_reader :attributes

        def to_hash
          attributes
        end

        def to_json(*args)
          to_hash.to_json(*args)
        end
      end
    end
  end
end