Exception: Mongo::Error::CryptError

Inherits:
Mongo::Error
  • Object
show all
Defined in:
lib/mongo/error/crypt_error.rb

Overview

An error related to client-side encryption.

Since:

  • 2.0.0

Direct Known Subclasses

KmsError, MongocryptdSpawnError

Constant Summary

Constants inherited from Mongo::Error

BAD_VALUE, CODE, CURSOR_NOT_FOUND, ERR, ERRMSG, ERROR, TRANSIENT_TRANSACTION_ERROR_LABEL, UNKNOWN_ERROR, UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL, WRITE_CONCERN_ERROR, WRITE_CONCERN_ERRORS, WRITE_ERRORS

Instance Attribute Summary

Attributes included from Notable

#connection_global_id, #generation, #service_id

Instance Method Summary collapse

Methods inherited from Mongo::Error

#change_stream_resumable?, #write_concern_error_label?, #write_concern_error_labels

Methods included from ChangeStreamResumable

#change_stream_resumable?

Methods included from WriteRetryable

#write_retryable?

Methods included from Labelable

#add_label, #label?, #labels

Methods included from Notable

#add_note, #add_notes, #notes, #to_s

Constructor Details

#initialize(message, code: nil) ⇒ CryptError

Create a new CryptError

Parameters:

  • code (Integer | nil) (defaults to: nil) —

    The optional libmongocrypt error code

  • message (String) —

    The error message

Since:

  • 2.0.0



27
28
29
30
31
 
# File 'lib/mongo/error/crypt_error.rb', line 27

def initialize(message, code: nil)
  msg = message
  msg += " (libmongocrypt error code #{code})" if code
  super(msg)
end