Exception: GLI::CustomExit

Inherits:
StandardError
  • Object
show all
Includes:
StandardException
Defined in:
lib/gli/exceptions.rb

Overview

Raise this if you want to use an exit status that isn’t the default provided by GLI. Note that GLI::App#exit_now! might be a bit more to your liking.

Example:

raise CustomExit.new("Not connected to DB",-5) unless connected?
raise CustomExit.new("Bad SQL",-6) unless valid_sql?(args[0])

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message, exit_code) ⇒ CustomExit

Create a custom exit exception

message

String containing error message to show the user

exit_code

the exit code to use (as an Int), overridding GLI’s default



117
118
119
120
 
# File 'lib/gli/exceptions.rb', line 117

def initialize(message,exit_code)
  super(message)
  @exit_code = exit_code
end

Instance Attribute Details

#exit_code ⇒ Object (readonly)

:nodoc:



112
113
114
 
# File 'lib/gli/exceptions.rb', line 112

def exit_code
  @exit_code
end