mongodb/mongo-ruby-driver

View on GitHub
lib/mongo/error/invalid_document.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true
# encoding: utf-8

# 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
  class Error

    # Exception raised if the object is not a valid document.
    #
    # @since 2.0.0
    class InvalidDocument < Error

      # The error message.
      #
      # @since 2.0.0
      MESSAGE = 'Invalid document provided.'.freeze

      # Instantiate the new exception.
      #
      # @example Instantiate the exception.
      #   Mongo::Error::InvalidDocument.new
      #
      # @since 2.0.0
      def initialize
        super(MESSAGE)
      end
    end
  end
end