Exception: R10K::Error

Inherits:

StandardError

• Object
• StandardError
• R10K::Error

Defined in:

lib/r10k/errors.rb

Overview

An error class that accepts an optional hash and wrapped error message

Direct Known Subclasses

ConfigError, Deployment::Config::ConfigError, Git::GitError, Settings::Collection::ValidationError, Settings::List::ValidationError, Settings::Loader::ConfigError, Util::Subprocess::SubprocessError

Instance Attribute Summary

• #original ⇒ Object

  Returns the value of attribute original.

Class Method Summary

• .wrap(original, mesg, options = {}) ⇒ R10K::Error

  Generate a wrapped exception.

Instance Method Summary

• #initialize(mesg, options = {}) ⇒ Error constructor

  A new instance of Error.

Constructor Details

#initialize(mesg) ⇒ Error #initialize(mesg, options) ⇒ Error

Returns a new instance of Error.

Overloads:

• #initialize(mesg) ⇒ Error

  Parameters:

  • mesg (String) —

    The exception mesg

• #initialize(mesg, options) ⇒ Error

  Parameters:

  • mesg (String) —

    The exception mesg

  • options (Hash) —

    A set of options to store on the exception

# File 'lib/r10k/errors.rb', line 32

def initialize(mesg, options = {})
  super(mesg)

  bt = options.delete(:backtrace)
  if bt
    set_backtrace(bt)
  end

  @options = options
end

Instance Attribute Details

#original ⇒ Object

Returns the value of attribute original.

# File 'lib/r10k/errors.rb', line 8

def original
  @original
end

Class Method Details

.wrap(original, mesg, options = {}) ⇒ R10K::Error

Generate a wrapped exception

Parameters:

• original (Exception) —

  The exception to wrap

• mesg (String)
• options (Hash) (defaults to: {})

Returns:

• (R10K::Error)

# File 'lib/r10k/errors.rb', line 17

def self.wrap(original, mesg, options = {})
  new(mesg, options).tap do |e|
    e.set_backtrace(caller(4))
    e.original = original
  end
end