Exception: Kotoshu::ConfigurationError

Inherits:

Error

• Object
• StandardError
• Error
• Kotoshu::ConfigurationError

Defined in:

lib/kotoshu/core/exceptions.rb

Overview

Error raised when there is a configuration issue.

Examples:

Invalid configuration

raise ConfigurationError, "Invalid dictionary type: unknown_type"

Instance Attribute Summary

• #key ⇒ String, ... readonly

  The configuration key.

Instance Method Summary

• #initialize(message, key: nil) ⇒ ConfigurationError constructor

  Create a new configuration error.

Constructor Details

#initialize(message, key: nil) ⇒ ConfigurationError

Create a new configuration error.

Parameters:

• message (String) —

  The error message

• key (String, Symbol) (defaults to: nil) —

  The configuration key (optional)

# File 'lib/kotoshu/core/exceptions.rb', line 59

def initialize(message, key: nil)
  @key = key
  super(message)
end

Instance Attribute Details

#key ⇒ String, ... (readonly)

Returns The configuration key.

Returns:

• (String, Symbol, nil) —

  The configuration key

# File 'lib/kotoshu/core/exceptions.rb', line 65

def key
  @key
end