123456789_123456789_123456789_123456789_123456789_

Class: Mongo::Error::MaxBSONSize

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Error
Instance Chain:
self, Error
Inherits: Error
  • Object
Defined in: lib/mongo/error/max_bson_size.rb

Overview

Exception that is raised when trying to serialize a document that exceeds max BSON object size.

Since:

  • 2.0.0

Constant Summary

Class Method Summary

Constructor Details

.new(max_size_or_msg = nil) ⇒ MaxBSONSize

Instantiate the new exception.

Examples:

Instantiate the exception.

Mongo::Error::MaxBSONSize.new(max)

Parameters:

  • max_size_or_msg (String | Numeric) (defaults to: nil) —

    The message to use or the maximum size to insert into the predefined message. The Numeric argument type is deprecated.

Since:

  • 2.0.0

[ GitHub ] 

  


# File 'lib/mongo/error/max_bson_size.rb', line 39



def initialize(max_size_or_msg = nil)
  msg = if max_size_or_msg.is_a?(Numeric)
          "#{MESSAGE}. The maximum allowed size is #{max_size_or_msg}"
        elsif max_size_or_msg
          max_size_or_msg
        else
          MESSAGE
        end
  super(msg)
end